| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Network.AWS.ECS.Types
Contents
- Service Configuration
- Errors
- AgentUpdateStatus
- AssignPublicIp
- CapacityProviderField
- CapacityProviderStatus
- CapacityProviderUpdateStatus
- ClusterField
- ClusterSettingName
- Compatibility
- Connectivity
- ContainerCondition
- ContainerInstanceField
- ContainerInstanceStatus
- DeploymentControllerType
- DeploymentRolloutState
- DesiredStatus
- DeviceCgroupPermission
- EFSAuthorizationConfigIAM
- EFSTransitEncryption
- EnvironmentFileType
- ExecuteCommandLogging
- FirelensConfigurationType
- HealthStatus
- IpcMode
- LaunchType
- LogDriver
- ManagedAgentName
- ManagedScalingStatus
- ManagedTerminationProtection
- NetworkMode
- PidMode
- PlacementConstraintType
- PlacementStrategyType
- PlatformDeviceType
- PropagateTags
- ProxyConfigurationType
- ResourceType
- ScaleUnit
- SchedulingStrategy
- Scope
- ServiceField
- SettingName
- SortOrder
- StabilityStatus
- TargetType
- TaskDefinitionFamilyStatus
- TaskDefinitionField
- TaskDefinitionPlacementConstraintType
- TaskDefinitionStatus
- TaskField
- TaskSetField
- TaskStopCode
- TransportProtocol
- UlimitName
- Attachment
- AttachmentStateChange
- Attribute
- AutoScalingGroupProvider
- AutoScalingGroupProviderUpdate
- AwsVpcConfiguration
- CapacityProvider
- CapacityProviderStrategyItem
- Cluster
- ClusterConfiguration
- ClusterSetting
- Container
- ContainerDefinition
- ContainerDependency
- ContainerInstance
- ContainerOverride
- ContainerService
- ContainerStateChange
- Deployment
- DeploymentCircuitBreaker
- DeploymentConfiguration
- DeploymentController
- Device
- DockerVolumeConfiguration
- EFSAuthorizationConfig
- EFSVolumeConfiguration
- EnvironmentFile
- EphemeralStorage
- ExecuteCommandConfiguration
- ExecuteCommandLogConfiguration
- FSxWindowsFileServerAuthorizationConfig
- FSxWindowsFileServerVolumeConfiguration
- Failure
- FirelensConfiguration
- HealthCheck
- HostEntry
- HostVolumeProperties
- InferenceAccelerator
- InferenceAcceleratorOverride
- KernelCapabilities
- KeyValuePair
- LinuxParameters
- LoadBalancer
- LogConfiguration
- ManagedAgent
- ManagedAgentStateChange
- ManagedScaling
- MountPoint
- NetworkBinding
- NetworkConfiguration
- NetworkInterface
- PlacementConstraint
- PlacementStrategy
- PlatformDevice
- PortMapping
- ProxyConfiguration
- RepositoryCredentials
- Resource
- ResourceRequirement
- Scale
- Secret
- ServiceEvent
- ServiceRegistry
- Session
- Setting
- SystemControl
- Tag
- Task
- TaskDefinition
- TaskDefinitionPlacementConstraint
- TaskOverride
- TaskSet
- Tmpfs
- Ulimit
- VersionInfo
- Volume
- VolumeFrom
Description
Synopsis
- defaultService :: Service
- _UpdateInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _TargetNotConnectedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PlatformTaskDefinitionIncompatibilityException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedFeatureException :: AsError a => Getting (First ServiceError) a ServiceError
- _TaskSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterContainsContainerInstancesException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterContainsServicesException :: AsError a => Getting (First ServiceError) a ServiceError
- _PlatformUnknownException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _BlockedException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingVersionException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClientException :: AsError a => Getting (First ServiceError) a ServiceError
- _NoUpdateAvailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceNotActiveException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterContainsTasksException :: AsError a => Getting (First ServiceError) a ServiceError
- _AttributeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _TargetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServerException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AgentUpdateStatus where
- AgentUpdateStatus' { }
- pattern AgentUpdateStatus_FAILED :: AgentUpdateStatus
- pattern AgentUpdateStatus_PENDING :: AgentUpdateStatus
- pattern AgentUpdateStatus_STAGED :: AgentUpdateStatus
- pattern AgentUpdateStatus_STAGING :: AgentUpdateStatus
- pattern AgentUpdateStatus_UPDATED :: AgentUpdateStatus
- pattern AgentUpdateStatus_UPDATING :: AgentUpdateStatus
- newtype AssignPublicIp where
- AssignPublicIp' { }
- pattern AssignPublicIp_DISABLED :: AssignPublicIp
- pattern AssignPublicIp_ENABLED :: AssignPublicIp
- newtype CapacityProviderField where
- newtype CapacityProviderStatus where
- newtype CapacityProviderUpdateStatus where
- CapacityProviderUpdateStatus' { }
- pattern CapacityProviderUpdateStatus_DELETE_COMPLETE :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_DELETE_FAILED :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_DELETE_IN_PROGRESS :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_UPDATE_COMPLETE :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_UPDATE_FAILED :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_UPDATE_IN_PROGRESS :: CapacityProviderUpdateStatus
- newtype ClusterField where
- ClusterField' { }
- pattern ClusterField_ATTACHMENTS :: ClusterField
- pattern ClusterField_CONFIGURATIONS :: ClusterField
- pattern ClusterField_SETTINGS :: ClusterField
- pattern ClusterField_STATISTICS :: ClusterField
- pattern ClusterField_TAGS :: ClusterField
- newtype ClusterSettingName where
- newtype Compatibility where
- Compatibility' { }
- pattern Compatibility_EC2 :: Compatibility
- pattern Compatibility_EXTERNAL :: Compatibility
- pattern Compatibility_FARGATE :: Compatibility
- newtype Connectivity where
- Connectivity' { }
- pattern Connectivity_CONNECTED :: Connectivity
- pattern Connectivity_DISCONNECTED :: Connectivity
- newtype ContainerCondition where
- ContainerCondition' { }
- pattern ContainerCondition_COMPLETE :: ContainerCondition
- pattern ContainerCondition_HEALTHY :: ContainerCondition
- pattern ContainerCondition_START :: ContainerCondition
- pattern ContainerCondition_SUCCESS :: ContainerCondition
- newtype ContainerInstanceField where
- newtype ContainerInstanceStatus where
- ContainerInstanceStatus' { }
- pattern ContainerInstanceStatus_ACTIVE :: ContainerInstanceStatus
- pattern ContainerInstanceStatus_DEREGISTERING :: ContainerInstanceStatus
- pattern ContainerInstanceStatus_DRAINING :: ContainerInstanceStatus
- pattern ContainerInstanceStatus_REGISTERING :: ContainerInstanceStatus
- pattern ContainerInstanceStatus_REGISTRATION_FAILED :: ContainerInstanceStatus
- newtype DeploymentControllerType where
- newtype DeploymentRolloutState where
- newtype DesiredStatus where
- DesiredStatus' { }
- pattern DesiredStatus_PENDING :: DesiredStatus
- pattern DesiredStatus_RUNNING :: DesiredStatus
- pattern DesiredStatus_STOPPED :: DesiredStatus
- newtype DeviceCgroupPermission where
- newtype EFSAuthorizationConfigIAM where
- newtype EFSTransitEncryption where
- newtype EnvironmentFileType where
- newtype ExecuteCommandLogging where
- newtype FirelensConfigurationType where
- newtype HealthStatus where
- HealthStatus' { }
- pattern HealthStatus_HEALTHY :: HealthStatus
- pattern HealthStatus_UNHEALTHY :: HealthStatus
- pattern HealthStatus_UNKNOWN :: HealthStatus
- newtype IpcMode where
- IpcMode' {
- fromIpcMode :: Text
- pattern IpcMode_Host :: IpcMode
- pattern IpcMode_None :: IpcMode
- pattern IpcMode_Task :: IpcMode
- IpcMode' {
- newtype LaunchType where
- LaunchType' { }
- pattern LaunchType_EC2 :: LaunchType
- pattern LaunchType_EXTERNAL :: LaunchType
- pattern LaunchType_FARGATE :: LaunchType
- newtype LogDriver where
- LogDriver' { }
- pattern LogDriver_Awsfirelens :: LogDriver
- pattern LogDriver_Awslogs :: LogDriver
- pattern LogDriver_Fluentd :: LogDriver
- pattern LogDriver_Gelf :: LogDriver
- pattern LogDriver_Journald :: LogDriver
- pattern LogDriver_Json_file :: LogDriver
- pattern LogDriver_Splunk :: LogDriver
- pattern LogDriver_Syslog :: LogDriver
- newtype ManagedAgentName where
- newtype ManagedScalingStatus where
- newtype ManagedTerminationProtection where
- newtype NetworkMode where
- NetworkMode' { }
- pattern NetworkMode_Awsvpc :: NetworkMode
- pattern NetworkMode_Bridge :: NetworkMode
- pattern NetworkMode_Host :: NetworkMode
- pattern NetworkMode_None :: NetworkMode
- newtype PidMode where
- PidMode' {
- fromPidMode :: Text
- pattern PidMode_Host :: PidMode
- pattern PidMode_Task :: PidMode
- PidMode' {
- newtype PlacementConstraintType where
- newtype PlacementStrategyType where
- newtype PlatformDeviceType where
- newtype PropagateTags where
- PropagateTags' { }
- pattern PropagateTags_SERVICE :: PropagateTags
- pattern PropagateTags_TASK_DEFINITION :: PropagateTags
- newtype ProxyConfigurationType where
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_GPU :: ResourceType
- pattern ResourceType_InferenceAccelerator :: ResourceType
- newtype ScaleUnit where
- ScaleUnit' { }
- pattern ScaleUnit_PERCENT :: ScaleUnit
- newtype SchedulingStrategy where
- SchedulingStrategy' { }
- pattern SchedulingStrategy_DAEMON :: SchedulingStrategy
- pattern SchedulingStrategy_REPLICA :: SchedulingStrategy
- newtype Scope where
- Scope' { }
- pattern Scope_Shared :: Scope
- pattern Scope_Task :: Scope
- newtype ServiceField where
- ServiceField' { }
- pattern ServiceField_TAGS :: ServiceField
- newtype SettingName where
- SettingName' { }
- pattern SettingName_AwsvpcTrunking :: SettingName
- pattern SettingName_ContainerInsights :: SettingName
- pattern SettingName_ContainerInstanceLongArnFormat :: SettingName
- pattern SettingName_ServiceLongArnFormat :: SettingName
- pattern SettingName_TaskLongArnFormat :: SettingName
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASC :: SortOrder
- pattern SortOrder_DESC :: SortOrder
- newtype StabilityStatus where
- StabilityStatus' { }
- pattern StabilityStatus_STABILIZING :: StabilityStatus
- pattern StabilityStatus_STEADY_STATE :: StabilityStatus
- newtype TargetType where
- TargetType' { }
- pattern TargetType_Container_instance :: TargetType
- newtype TaskDefinitionFamilyStatus where
- newtype TaskDefinitionField where
- newtype TaskDefinitionPlacementConstraintType where
- newtype TaskDefinitionStatus where
- newtype TaskField where
- TaskField' { }
- pattern TaskField_TAGS :: TaskField
- newtype TaskSetField where
- TaskSetField' { }
- pattern TaskSetField_TAGS :: TaskSetField
- newtype TaskStopCode where
- TaskStopCode' { }
- pattern TaskStopCode_EssentialContainerExited :: TaskStopCode
- pattern TaskStopCode_TaskFailedToStart :: TaskStopCode
- pattern TaskStopCode_UserInitiated :: TaskStopCode
- newtype TransportProtocol where
- TransportProtocol' { }
- pattern TransportProtocol_Tcp :: TransportProtocol
- pattern TransportProtocol_Udp :: TransportProtocol
- newtype UlimitName where
- UlimitName' { }
- pattern UlimitName_Core :: UlimitName
- pattern UlimitName_Cpu :: UlimitName
- pattern UlimitName_Data :: UlimitName
- pattern UlimitName_Fsize :: UlimitName
- pattern UlimitName_Locks :: UlimitName
- pattern UlimitName_Memlock :: UlimitName
- pattern UlimitName_Msgqueue :: UlimitName
- pattern UlimitName_Nice :: UlimitName
- pattern UlimitName_Nofile :: UlimitName
- pattern UlimitName_Nproc :: UlimitName
- pattern UlimitName_Rss :: UlimitName
- pattern UlimitName_Rtprio :: UlimitName
- pattern UlimitName_Rttime :: UlimitName
- pattern UlimitName_Sigpending :: UlimitName
- pattern UlimitName_Stack :: UlimitName
- data Attachment = Attachment' {}
- newAttachment :: Attachment
- attachment_status :: Lens' Attachment (Maybe Text)
- attachment_id :: Lens' Attachment (Maybe Text)
- attachment_details :: Lens' Attachment (Maybe [KeyValuePair])
- attachment_type :: Lens' Attachment (Maybe Text)
- data AttachmentStateChange = AttachmentStateChange' {
- attachmentArn :: Text
- status :: Text
- newAttachmentStateChange :: Text -> Text -> AttachmentStateChange
- attachmentStateChange_attachmentArn :: Lens' AttachmentStateChange Text
- attachmentStateChange_status :: Lens' AttachmentStateChange Text
- data Attribute = Attribute' {}
- newAttribute :: Text -> Attribute
- attribute_targetId :: Lens' Attribute (Maybe Text)
- attribute_targetType :: Lens' Attribute (Maybe TargetType)
- attribute_value :: Lens' Attribute (Maybe Text)
- attribute_name :: Lens' Attribute Text
- data AutoScalingGroupProvider = AutoScalingGroupProvider' {}
- newAutoScalingGroupProvider :: Text -> AutoScalingGroupProvider
- autoScalingGroupProvider_managedScaling :: Lens' AutoScalingGroupProvider (Maybe ManagedScaling)
- autoScalingGroupProvider_managedTerminationProtection :: Lens' AutoScalingGroupProvider (Maybe ManagedTerminationProtection)
- autoScalingGroupProvider_autoScalingGroupArn :: Lens' AutoScalingGroupProvider Text
- data AutoScalingGroupProviderUpdate = AutoScalingGroupProviderUpdate' {}
- newAutoScalingGroupProviderUpdate :: AutoScalingGroupProviderUpdate
- autoScalingGroupProviderUpdate_managedScaling :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedScaling)
- autoScalingGroupProviderUpdate_managedTerminationProtection :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedTerminationProtection)
- data AwsVpcConfiguration = AwsVpcConfiguration' {
- assignPublicIp :: Maybe AssignPublicIp
- securityGroups :: Maybe [Text]
- subnets :: [Text]
- newAwsVpcConfiguration :: AwsVpcConfiguration
- awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp)
- awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text])
- awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text]
- data CapacityProvider = CapacityProvider' {}
- newCapacityProvider :: CapacityProvider
- capacityProvider_status :: Lens' CapacityProvider (Maybe CapacityProviderStatus)
- capacityProvider_updateStatusReason :: Lens' CapacityProvider (Maybe Text)
- capacityProvider_capacityProviderArn :: Lens' CapacityProvider (Maybe Text)
- capacityProvider_updateStatus :: Lens' CapacityProvider (Maybe CapacityProviderUpdateStatus)
- capacityProvider_name :: Lens' CapacityProvider (Maybe Text)
- capacityProvider_autoScalingGroupProvider :: Lens' CapacityProvider (Maybe AutoScalingGroupProvider)
- capacityProvider_tags :: Lens' CapacityProvider (Maybe [Tag])
- data CapacityProviderStrategyItem = CapacityProviderStrategyItem' {}
- newCapacityProviderStrategyItem :: Text -> CapacityProviderStrategyItem
- capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text
- data Cluster = Cluster' {
- clusterArn :: Maybe Text
- status :: Maybe Text
- activeServicesCount :: Maybe Int
- registeredContainerInstancesCount :: Maybe Int
- configuration :: Maybe ClusterConfiguration
- statistics :: Maybe [KeyValuePair]
- defaultCapacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- pendingTasksCount :: Maybe Int
- tags :: Maybe [Tag]
- capacityProviders :: Maybe [Text]
- attachmentsStatus :: Maybe Text
- clusterName :: Maybe Text
- settings :: Maybe [ClusterSetting]
- runningTasksCount :: Maybe Int
- attachments :: Maybe [Attachment]
- newCluster :: Cluster
- cluster_clusterArn :: Lens' Cluster (Maybe Text)
- cluster_status :: Lens' Cluster (Maybe Text)
- cluster_activeServicesCount :: Lens' Cluster (Maybe Int)
- cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int)
- cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration)
- cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair])
- cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem])
- cluster_pendingTasksCount :: Lens' Cluster (Maybe Int)
- cluster_tags :: Lens' Cluster (Maybe [Tag])
- cluster_capacityProviders :: Lens' Cluster (Maybe [Text])
- cluster_attachmentsStatus :: Lens' Cluster (Maybe Text)
- cluster_clusterName :: Lens' Cluster (Maybe Text)
- cluster_settings :: Lens' Cluster (Maybe [ClusterSetting])
- cluster_runningTasksCount :: Lens' Cluster (Maybe Int)
- cluster_attachments :: Lens' Cluster (Maybe [Attachment])
- data ClusterConfiguration = ClusterConfiguration' {}
- newClusterConfiguration :: ClusterConfiguration
- clusterConfiguration_executeCommandConfiguration :: Lens' ClusterConfiguration (Maybe ExecuteCommandConfiguration)
- data ClusterSetting = ClusterSetting' {}
- newClusterSetting :: ClusterSetting
- clusterSetting_name :: Lens' ClusterSetting (Maybe ClusterSettingName)
- clusterSetting_value :: Lens' ClusterSetting (Maybe Text)
- data Container = Container' {
- imageDigest :: Maybe Text
- gpuIds :: Maybe [Text]
- memoryReservation :: Maybe Text
- memory :: Maybe Text
- runtimeId :: Maybe Text
- exitCode :: Maybe Int
- containerArn :: Maybe Text
- name :: Maybe Text
- image :: Maybe Text
- managedAgents :: Maybe [ManagedAgent]
- networkBindings :: Maybe [NetworkBinding]
- reason :: Maybe Text
- lastStatus :: Maybe Text
- cpu :: Maybe Text
- networkInterfaces :: Maybe [NetworkInterface]
- healthStatus :: Maybe HealthStatus
- taskArn :: Maybe Text
- newContainer :: Container
- container_imageDigest :: Lens' Container (Maybe Text)
- container_gpuIds :: Lens' Container (Maybe [Text])
- container_memoryReservation :: Lens' Container (Maybe Text)
- container_memory :: Lens' Container (Maybe Text)
- container_runtimeId :: Lens' Container (Maybe Text)
- container_exitCode :: Lens' Container (Maybe Int)
- container_containerArn :: Lens' Container (Maybe Text)
- container_name :: Lens' Container (Maybe Text)
- container_image :: Lens' Container (Maybe Text)
- container_managedAgents :: Lens' Container (Maybe [ManagedAgent])
- container_networkBindings :: Lens' Container (Maybe [NetworkBinding])
- container_reason :: Lens' Container (Maybe Text)
- container_lastStatus :: Lens' Container (Maybe Text)
- container_cpu :: Lens' Container (Maybe Text)
- container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface])
- container_healthStatus :: Lens' Container (Maybe HealthStatus)
- container_taskArn :: Lens' Container (Maybe Text)
- data ContainerDefinition = ContainerDefinition' {
- hostname :: Maybe Text
- linuxParameters :: Maybe LinuxParameters
- firelensConfiguration :: Maybe FirelensConfiguration
- dependsOn :: Maybe [ContainerDependency]
- memoryReservation :: Maybe Int
- dockerLabels :: Maybe (HashMap Text Text)
- memory :: Maybe Int
- extraHosts :: Maybe [HostEntry]
- user :: Maybe Text
- systemControls :: Maybe [SystemControl]
- privileged :: Maybe Bool
- links :: Maybe [Text]
- interactive :: Maybe Bool
- environmentFiles :: Maybe [EnvironmentFile]
- entryPoint :: Maybe [Text]
- workingDirectory :: Maybe Text
- environment :: Maybe [KeyValuePair]
- secrets :: Maybe [Secret]
- volumesFrom :: Maybe [VolumeFrom]
- mountPoints :: Maybe [MountPoint]
- command :: Maybe [Text]
- dnsServers :: Maybe [Text]
- name :: Maybe Text
- image :: Maybe Text
- dnsSearchDomains :: Maybe [Text]
- pseudoTerminal :: Maybe Bool
- logConfiguration :: Maybe LogConfiguration
- portMappings :: Maybe [PortMapping]
- essential :: Maybe Bool
- cpu :: Maybe Int
- resourceRequirements :: Maybe [ResourceRequirement]
- ulimits :: Maybe [Ulimit]
- startTimeout :: Maybe Int
- readonlyRootFilesystem :: Maybe Bool
- stopTimeout :: Maybe Int
- healthCheck :: Maybe HealthCheck
- dockerSecurityOptions :: Maybe [Text]
- disableNetworking :: Maybe Bool
- repositoryCredentials :: Maybe RepositoryCredentials
- newContainerDefinition :: ContainerDefinition
- containerDefinition_hostname :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_linuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters)
- containerDefinition_firelensConfiguration :: Lens' ContainerDefinition (Maybe FirelensConfiguration)
- containerDefinition_dependsOn :: Lens' ContainerDefinition (Maybe [ContainerDependency])
- containerDefinition_memoryReservation :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_dockerLabels :: Lens' ContainerDefinition (Maybe (HashMap Text Text))
- containerDefinition_memory :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_extraHosts :: Lens' ContainerDefinition (Maybe [HostEntry])
- containerDefinition_user :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_systemControls :: Lens' ContainerDefinition (Maybe [SystemControl])
- containerDefinition_privileged :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_links :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_interactive :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_environmentFiles :: Lens' ContainerDefinition (Maybe [EnvironmentFile])
- containerDefinition_entryPoint :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_workingDirectory :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_environment :: Lens' ContainerDefinition (Maybe [KeyValuePair])
- containerDefinition_secrets :: Lens' ContainerDefinition (Maybe [Secret])
- containerDefinition_volumesFrom :: Lens' ContainerDefinition (Maybe [VolumeFrom])
- containerDefinition_mountPoints :: Lens' ContainerDefinition (Maybe [MountPoint])
- containerDefinition_command :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_dnsServers :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_name :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_image :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_dnsSearchDomains :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_pseudoTerminal :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_logConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration)
- containerDefinition_portMappings :: Lens' ContainerDefinition (Maybe [PortMapping])
- containerDefinition_essential :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_cpu :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_resourceRequirements :: Lens' ContainerDefinition (Maybe [ResourceRequirement])
- containerDefinition_ulimits :: Lens' ContainerDefinition (Maybe [Ulimit])
- containerDefinition_startTimeout :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_readonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_stopTimeout :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_healthCheck :: Lens' ContainerDefinition (Maybe HealthCheck)
- containerDefinition_dockerSecurityOptions :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_disableNetworking :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_repositoryCredentials :: Lens' ContainerDefinition (Maybe RepositoryCredentials)
- data ContainerDependency = ContainerDependency' {}
- newContainerDependency :: Text -> ContainerCondition -> ContainerDependency
- containerDependency_containerName :: Lens' ContainerDependency Text
- containerDependency_condition :: Lens' ContainerDependency ContainerCondition
- data ContainerInstance = ContainerInstance' {
- agentUpdateStatus :: Maybe AgentUpdateStatus
- versionInfo :: Maybe VersionInfo
- status :: Maybe Text
- registeredResources :: Maybe [Resource]
- containerInstanceArn :: Maybe Text
- registeredAt :: Maybe POSIX
- pendingTasksCount :: Maybe Int
- version :: Maybe Integer
- attributes :: Maybe [Attribute]
- tags :: Maybe [Tag]
- agentConnected :: Maybe Bool
- ec2InstanceId :: Maybe Text
- statusReason :: Maybe Text
- remainingResources :: Maybe [Resource]
- runningTasksCount :: Maybe Int
- capacityProviderName :: Maybe Text
- attachments :: Maybe [Attachment]
- newContainerInstance :: ContainerInstance
- containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus)
- containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo)
- containerInstance_status :: Lens' ContainerInstance (Maybe Text)
- containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource])
- containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text)
- containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime)
- containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int)
- containerInstance_version :: Lens' ContainerInstance (Maybe Integer)
- containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute])
- containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag])
- containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool)
- containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text)
- containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text)
- containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource])
- containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int)
- containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text)
- containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment])
- data ContainerOverride = ContainerOverride' {
- memoryReservation :: Maybe Int
- memory :: Maybe Int
- environmentFiles :: Maybe [EnvironmentFile]
- environment :: Maybe [KeyValuePair]
- command :: Maybe [Text]
- name :: Maybe Text
- cpu :: Maybe Int
- resourceRequirements :: Maybe [ResourceRequirement]
- newContainerOverride :: ContainerOverride
- containerOverride_memoryReservation :: Lens' ContainerOverride (Maybe Int)
- containerOverride_memory :: Lens' ContainerOverride (Maybe Int)
- containerOverride_environmentFiles :: Lens' ContainerOverride (Maybe [EnvironmentFile])
- containerOverride_environment :: Lens' ContainerOverride (Maybe [KeyValuePair])
- containerOverride_command :: Lens' ContainerOverride (Maybe [Text])
- containerOverride_name :: Lens' ContainerOverride (Maybe Text)
- containerOverride_cpu :: Lens' ContainerOverride (Maybe Int)
- containerOverride_resourceRequirements :: Lens' ContainerOverride (Maybe [ResourceRequirement])
- data ContainerService = ContainerService' {
- clusterArn :: Maybe Text
- taskSets :: Maybe [TaskSet]
- runningCount :: Maybe Int
- status :: Maybe Text
- roleArn :: Maybe Text
- deploymentConfiguration :: Maybe DeploymentConfiguration
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- networkConfiguration :: Maybe NetworkConfiguration
- desiredCount :: Maybe Int
- enableECSManagedTags :: Maybe Bool
- deploymentController :: Maybe DeploymentController
- launchType :: Maybe LaunchType
- createdAt :: Maybe POSIX
- platformVersion :: Maybe Text
- deployments :: Maybe [Deployment]
- placementStrategy :: Maybe [PlacementStrategy]
- serviceName :: Maybe Text
- placementConstraints :: Maybe [PlacementConstraint]
- events :: Maybe [ServiceEvent]
- pendingCount :: Maybe Int
- enableExecuteCommand :: Maybe Bool
- loadBalancers :: Maybe [LoadBalancer]
- tags :: Maybe [Tag]
- healthCheckGracePeriodSeconds :: Maybe Int
- serviceRegistries :: Maybe [ServiceRegistry]
- createdBy :: Maybe Text
- schedulingStrategy :: Maybe SchedulingStrategy
- taskDefinition :: Maybe Text
- serviceArn :: Maybe Text
- propagateTags :: Maybe PropagateTags
- newContainerService :: ContainerService
- containerService_clusterArn :: Lens' ContainerService (Maybe Text)
- containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet])
- containerService_runningCount :: Lens' ContainerService (Maybe Int)
- containerService_status :: Lens' ContainerService (Maybe Text)
- containerService_roleArn :: Lens' ContainerService (Maybe Text)
- containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration)
- containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem])
- containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration)
- containerService_desiredCount :: Lens' ContainerService (Maybe Int)
- containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool)
- containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController)
- containerService_launchType :: Lens' ContainerService (Maybe LaunchType)
- containerService_createdAt :: Lens' ContainerService (Maybe UTCTime)
- containerService_platformVersion :: Lens' ContainerService (Maybe Text)
- containerService_deployments :: Lens' ContainerService (Maybe [Deployment])
- containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy])
- containerService_serviceName :: Lens' ContainerService (Maybe Text)
- containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint])
- containerService_events :: Lens' ContainerService (Maybe [ServiceEvent])
- containerService_pendingCount :: Lens' ContainerService (Maybe Int)
- containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool)
- containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer])
- containerService_tags :: Lens' ContainerService (Maybe [Tag])
- containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int)
- containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry])
- containerService_createdBy :: Lens' ContainerService (Maybe Text)
- containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy)
- containerService_taskDefinition :: Lens' ContainerService (Maybe Text)
- containerService_serviceArn :: Lens' ContainerService (Maybe Text)
- containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags)
- data ContainerStateChange = ContainerStateChange' {}
- newContainerStateChange :: ContainerStateChange
- containerStateChange_imageDigest :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_status :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_runtimeId :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_exitCode :: Lens' ContainerStateChange (Maybe Int)
- containerStateChange_networkBindings :: Lens' ContainerStateChange (Maybe [NetworkBinding])
- containerStateChange_reason :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_containerName :: Lens' ContainerStateChange (Maybe Text)
- data Deployment = Deployment' {
- rolloutState :: Maybe DeploymentRolloutState
- runningCount :: Maybe Int
- status :: Maybe Text
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- networkConfiguration :: Maybe NetworkConfiguration
- desiredCount :: Maybe Int
- updatedAt :: Maybe POSIX
- launchType :: Maybe LaunchType
- id :: Maybe Text
- createdAt :: Maybe POSIX
- platformVersion :: Maybe Text
- pendingCount :: Maybe Int
- taskDefinition :: Maybe Text
- rolloutStateReason :: Maybe Text
- failedTasks :: Maybe Int
- newDeployment :: Deployment
- deployment_rolloutState :: Lens' Deployment (Maybe DeploymentRolloutState)
- deployment_runningCount :: Lens' Deployment (Maybe Int)
- deployment_status :: Lens' Deployment (Maybe Text)
- deployment_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem])
- deployment_networkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration)
- deployment_desiredCount :: Lens' Deployment (Maybe Int)
- deployment_updatedAt :: Lens' Deployment (Maybe UTCTime)
- deployment_launchType :: Lens' Deployment (Maybe LaunchType)
- deployment_id :: Lens' Deployment (Maybe Text)
- deployment_createdAt :: Lens' Deployment (Maybe UTCTime)
- deployment_platformVersion :: Lens' Deployment (Maybe Text)
- deployment_pendingCount :: Lens' Deployment (Maybe Int)
- deployment_taskDefinition :: Lens' Deployment (Maybe Text)
- deployment_rolloutStateReason :: Lens' Deployment (Maybe Text)
- deployment_failedTasks :: Lens' Deployment (Maybe Int)
- data DeploymentCircuitBreaker = DeploymentCircuitBreaker' {}
- newDeploymentCircuitBreaker :: Bool -> Bool -> DeploymentCircuitBreaker
- deploymentCircuitBreaker_enable :: Lens' DeploymentCircuitBreaker Bool
- deploymentCircuitBreaker_rollback :: Lens' DeploymentCircuitBreaker Bool
- data DeploymentConfiguration = DeploymentConfiguration' {}
- newDeploymentConfiguration :: DeploymentConfiguration
- deploymentConfiguration_maximumPercent :: Lens' DeploymentConfiguration (Maybe Int)
- deploymentConfiguration_minimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int)
- deploymentConfiguration_deploymentCircuitBreaker :: Lens' DeploymentConfiguration (Maybe DeploymentCircuitBreaker)
- data DeploymentController = DeploymentController' {}
- newDeploymentController :: DeploymentControllerType -> DeploymentController
- deploymentController_type :: Lens' DeploymentController DeploymentControllerType
- data Device = Device' {}
- newDevice :: Text -> Device
- device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission])
- device_containerPath :: Lens' Device (Maybe Text)
- device_hostPath :: Lens' Device Text
- data DockerVolumeConfiguration = DockerVolumeConfiguration' {}
- newDockerVolumeConfiguration :: DockerVolumeConfiguration
- dockerVolumeConfiguration_labels :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text))
- dockerVolumeConfiguration_scope :: Lens' DockerVolumeConfiguration (Maybe Scope)
- dockerVolumeConfiguration_driverOpts :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text))
- dockerVolumeConfiguration_autoprovision :: Lens' DockerVolumeConfiguration (Maybe Bool)
- dockerVolumeConfiguration_driver :: Lens' DockerVolumeConfiguration (Maybe Text)
- data EFSAuthorizationConfig = EFSAuthorizationConfig' {}
- newEFSAuthorizationConfig :: EFSAuthorizationConfig
- eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text)
- eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM)
- data EFSVolumeConfiguration = EFSVolumeConfiguration' {}
- newEFSVolumeConfiguration :: Text -> EFSVolumeConfiguration
- eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int)
- eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text)
- eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig)
- eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption)
- eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text
- data EnvironmentFile = EnvironmentFile' {}
- newEnvironmentFile :: Text -> EnvironmentFileType -> EnvironmentFile
- environmentFile_value :: Lens' EnvironmentFile Text
- environmentFile_type :: Lens' EnvironmentFile EnvironmentFileType
- data EphemeralStorage = EphemeralStorage' {}
- newEphemeralStorage :: Int -> EphemeralStorage
- ephemeralStorage_sizeInGiB :: Lens' EphemeralStorage Int
- data ExecuteCommandConfiguration = ExecuteCommandConfiguration' {}
- newExecuteCommandConfiguration :: ExecuteCommandConfiguration
- executeCommandConfiguration_logging :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogging)
- executeCommandConfiguration_kmsKeyId :: Lens' ExecuteCommandConfiguration (Maybe Text)
- executeCommandConfiguration_logConfiguration :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogConfiguration)
- data ExecuteCommandLogConfiguration = ExecuteCommandLogConfiguration' {}
- newExecuteCommandLogConfiguration :: ExecuteCommandLogConfiguration
- executeCommandLogConfiguration_cloudWatchLogGroupName :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- executeCommandLogConfiguration_cloudWatchEncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool)
- executeCommandLogConfiguration_s3EncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool)
- executeCommandLogConfiguration_s3KeyPrefix :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- executeCommandLogConfiguration_s3BucketName :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- data FSxWindowsFileServerAuthorizationConfig = FSxWindowsFileServerAuthorizationConfig' {}
- newFSxWindowsFileServerAuthorizationConfig :: Text -> Text -> FSxWindowsFileServerAuthorizationConfig
- fSxWindowsFileServerAuthorizationConfig_credentialsParameter :: Lens' FSxWindowsFileServerAuthorizationConfig Text
- fSxWindowsFileServerAuthorizationConfig_domain :: Lens' FSxWindowsFileServerAuthorizationConfig Text
- data FSxWindowsFileServerVolumeConfiguration = FSxWindowsFileServerVolumeConfiguration' {}
- newFSxWindowsFileServerVolumeConfiguration :: Text -> Text -> FSxWindowsFileServerAuthorizationConfig -> FSxWindowsFileServerVolumeConfiguration
- fSxWindowsFileServerVolumeConfiguration_fileSystemId :: Lens' FSxWindowsFileServerVolumeConfiguration Text
- fSxWindowsFileServerVolumeConfiguration_rootDirectory :: Lens' FSxWindowsFileServerVolumeConfiguration Text
- fSxWindowsFileServerVolumeConfiguration_authorizationConfig :: Lens' FSxWindowsFileServerVolumeConfiguration FSxWindowsFileServerAuthorizationConfig
- data Failure = Failure' {}
- newFailure :: Failure
- failure_arn :: Lens' Failure (Maybe Text)
- failure_reason :: Lens' Failure (Maybe Text)
- failure_detail :: Lens' Failure (Maybe Text)
- data FirelensConfiguration = FirelensConfiguration' {}
- newFirelensConfiguration :: FirelensConfigurationType -> FirelensConfiguration
- firelensConfiguration_options :: Lens' FirelensConfiguration (Maybe (HashMap Text Text))
- firelensConfiguration_type :: Lens' FirelensConfiguration FirelensConfigurationType
- data HealthCheck = HealthCheck' {}
- newHealthCheck :: HealthCheck
- healthCheck_retries :: Lens' HealthCheck (Maybe Int)
- healthCheck_timeout :: Lens' HealthCheck (Maybe Int)
- healthCheck_startPeriod :: Lens' HealthCheck (Maybe Int)
- healthCheck_interval :: Lens' HealthCheck (Maybe Int)
- healthCheck_command :: Lens' HealthCheck [Text]
- data HostEntry = HostEntry' {}
- newHostEntry :: Text -> Text -> HostEntry
- hostEntry_hostname :: Lens' HostEntry Text
- hostEntry_ipAddress :: Lens' HostEntry Text
- data HostVolumeProperties = HostVolumeProperties' {
- sourcePath :: Maybe Text
- newHostVolumeProperties :: HostVolumeProperties
- hostVolumeProperties_sourcePath :: Lens' HostVolumeProperties (Maybe Text)
- data InferenceAccelerator = InferenceAccelerator' {
- deviceName :: Text
- deviceType :: Text
- newInferenceAccelerator :: Text -> Text -> InferenceAccelerator
- inferenceAccelerator_deviceName :: Lens' InferenceAccelerator Text
- inferenceAccelerator_deviceType :: Lens' InferenceAccelerator Text
- data InferenceAcceleratorOverride = InferenceAcceleratorOverride' {
- deviceName :: Maybe Text
- deviceType :: Maybe Text
- newInferenceAcceleratorOverride :: InferenceAcceleratorOverride
- inferenceAcceleratorOverride_deviceName :: Lens' InferenceAcceleratorOverride (Maybe Text)
- inferenceAcceleratorOverride_deviceType :: Lens' InferenceAcceleratorOverride (Maybe Text)
- data KernelCapabilities = KernelCapabilities' {}
- newKernelCapabilities :: KernelCapabilities
- kernelCapabilities_drop :: Lens' KernelCapabilities (Maybe [Text])
- kernelCapabilities_add :: Lens' KernelCapabilities (Maybe [Text])
- data KeyValuePair = KeyValuePair' {}
- newKeyValuePair :: KeyValuePair
- keyValuePair_name :: Lens' KeyValuePair (Maybe Text)
- keyValuePair_value :: Lens' KeyValuePair (Maybe Text)
- data LinuxParameters = LinuxParameters' {
- tmpfs :: Maybe [Tmpfs]
- maxSwap :: Maybe Int
- capabilities :: Maybe KernelCapabilities
- devices :: Maybe [Device]
- swappiness :: Maybe Int
- initProcessEnabled :: Maybe Bool
- sharedMemorySize :: Maybe Int
- newLinuxParameters :: LinuxParameters
- linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs])
- linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_capabilities :: Lens' LinuxParameters (Maybe KernelCapabilities)
- linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device])
- linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool)
- linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int)
- data LoadBalancer = LoadBalancer' {}
- newLoadBalancer :: LoadBalancer
- loadBalancer_targetGroupArn :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_containerPort :: Lens' LoadBalancer (Maybe Int)
- loadBalancer_containerName :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text)
- data LogConfiguration = LogConfiguration' {}
- newLogConfiguration :: LogDriver -> LogConfiguration
- logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text))
- logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret])
- logConfiguration_logDriver :: Lens' LogConfiguration LogDriver
- data ManagedAgent = ManagedAgent' {}
- newManagedAgent :: ManagedAgent
- managedAgent_name :: Lens' ManagedAgent (Maybe ManagedAgentName)
- managedAgent_reason :: Lens' ManagedAgent (Maybe Text)
- managedAgent_lastStatus :: Lens' ManagedAgent (Maybe Text)
- managedAgent_lastStartedAt :: Lens' ManagedAgent (Maybe UTCTime)
- data ManagedAgentStateChange = ManagedAgentStateChange' {}
- newManagedAgentStateChange :: Text -> ManagedAgentName -> Text -> ManagedAgentStateChange
- managedAgentStateChange_reason :: Lens' ManagedAgentStateChange (Maybe Text)
- managedAgentStateChange_containerName :: Lens' ManagedAgentStateChange Text
- managedAgentStateChange_managedAgentName :: Lens' ManagedAgentStateChange ManagedAgentName
- managedAgentStateChange_status :: Lens' ManagedAgentStateChange Text
- data ManagedScaling = ManagedScaling' {}
- newManagedScaling :: ManagedScaling
- managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus)
- managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_instanceWarmupPeriod :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_targetCapacity :: Lens' ManagedScaling (Maybe Natural)
- data MountPoint = MountPoint' {
- readOnly :: Maybe Bool
- sourceVolume :: Maybe Text
- containerPath :: Maybe Text
- newMountPoint :: MountPoint
- mountPoint_readOnly :: Lens' MountPoint (Maybe Bool)
- mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text)
- mountPoint_containerPath :: Lens' MountPoint (Maybe Text)
- data NetworkBinding = NetworkBinding' {}
- newNetworkBinding :: NetworkBinding
- networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int)
- networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text)
- networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol)
- networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int)
- data NetworkConfiguration = NetworkConfiguration' {}
- newNetworkConfiguration :: NetworkConfiguration
- networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration)
- data NetworkInterface = NetworkInterface' {}
- newNetworkInterface :: NetworkInterface
- networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text)
- data PlacementConstraint = PlacementConstraint' {}
- newPlacementConstraint :: PlacementConstraint
- placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType)
- placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text)
- data PlacementStrategy = PlacementStrategy' {}
- newPlacementStrategy :: PlacementStrategy
- placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType)
- placementStrategy_field :: Lens' PlacementStrategy (Maybe Text)
- data PlatformDevice = PlatformDevice' {
- id :: Text
- type' :: PlatformDeviceType
- newPlatformDevice :: Text -> PlatformDeviceType -> PlatformDevice
- platformDevice_id :: Lens' PlatformDevice Text
- platformDevice_type :: Lens' PlatformDevice PlatformDeviceType
- data PortMapping = PortMapping' {}
- newPortMapping :: PortMapping
- portMapping_hostPort :: Lens' PortMapping (Maybe Int)
- portMapping_protocol :: Lens' PortMapping (Maybe TransportProtocol)
- portMapping_containerPort :: Lens' PortMapping (Maybe Int)
- data ProxyConfiguration = ProxyConfiguration' {}
- newProxyConfiguration :: Text -> ProxyConfiguration
- proxyConfiguration_properties :: Lens' ProxyConfiguration (Maybe [KeyValuePair])
- proxyConfiguration_type :: Lens' ProxyConfiguration (Maybe ProxyConfigurationType)
- proxyConfiguration_containerName :: Lens' ProxyConfiguration Text
- data RepositoryCredentials = RepositoryCredentials' {}
- newRepositoryCredentials :: Text -> RepositoryCredentials
- repositoryCredentials_credentialsParameter :: Lens' RepositoryCredentials Text
- data Resource = Resource' {}
- newResource :: Resource
- resource_stringSetValue :: Lens' Resource (Maybe [Text])
- resource_doubleValue :: Lens' Resource (Maybe Double)
- resource_name :: Lens' Resource (Maybe Text)
- resource_longValue :: Lens' Resource (Maybe Integer)
- resource_type :: Lens' Resource (Maybe Text)
- resource_integerValue :: Lens' Resource (Maybe Int)
- data ResourceRequirement = ResourceRequirement' {
- value :: Text
- type' :: ResourceType
- newResourceRequirement :: Text -> ResourceType -> ResourceRequirement
- resourceRequirement_value :: Lens' ResourceRequirement Text
- resourceRequirement_type :: Lens' ResourceRequirement ResourceType
- data Scale = Scale' {}
- newScale :: Scale
- scale_unit :: Lens' Scale (Maybe ScaleUnit)
- scale_value :: Lens' Scale (Maybe Double)
- data Secret = Secret' {}
- newSecret :: Text -> Text -> Secret
- secret_name :: Lens' Secret Text
- secret_valueFrom :: Lens' Secret Text
- data ServiceEvent = ServiceEvent' {}
- newServiceEvent :: ServiceEvent
- serviceEvent_message :: Lens' ServiceEvent (Maybe Text)
- serviceEvent_id :: Lens' ServiceEvent (Maybe Text)
- serviceEvent_createdAt :: Lens' ServiceEvent (Maybe UTCTime)
- data ServiceRegistry = ServiceRegistry' {
- port :: Maybe Int
- containerPort :: Maybe Int
- containerName :: Maybe Text
- registryArn :: Maybe Text
- newServiceRegistry :: ServiceRegistry
- serviceRegistry_port :: Lens' ServiceRegistry (Maybe Int)
- serviceRegistry_containerPort :: Lens' ServiceRegistry (Maybe Int)
- serviceRegistry_containerName :: Lens' ServiceRegistry (Maybe Text)
- serviceRegistry_registryArn :: Lens' ServiceRegistry (Maybe Text)
- data Session = Session' {}
- newSession :: Session
- session_sessionId :: Lens' Session (Maybe Text)
- session_streamUrl :: Lens' Session (Maybe Text)
- session_tokenValue :: Lens' Session (Maybe Text)
- data Setting = Setting' {
- name :: Maybe SettingName
- principalArn :: Maybe Text
- value :: Maybe Text
- newSetting :: Setting
- setting_name :: Lens' Setting (Maybe SettingName)
- setting_principalArn :: Lens' Setting (Maybe Text)
- setting_value :: Lens' Setting (Maybe Text)
- data SystemControl = SystemControl' {}
- newSystemControl :: SystemControl
- systemControl_value :: Lens' SystemControl (Maybe Text)
- systemControl_namespace :: Lens' SystemControl (Maybe Text)
- data Tag = Tag' {}
- newTag :: Tag
- tag_key :: Lens' Tag (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
- data Task = Task' {
- clusterArn :: Maybe Text
- startedAt :: Maybe POSIX
- memory :: Maybe Text
- pullStartedAt :: Maybe POSIX
- containerInstanceArn :: Maybe Text
- launchType :: Maybe LaunchType
- createdAt :: Maybe POSIX
- platformVersion :: Maybe Text
- connectivity :: Maybe Connectivity
- stoppingAt :: Maybe POSIX
- startedBy :: Maybe Text
- version :: Maybe Integer
- group' :: Maybe Text
- availabilityZone :: Maybe Text
- inferenceAccelerators :: Maybe [InferenceAccelerator]
- attributes :: Maybe [Attribute]
- overrides :: Maybe TaskOverride
- desiredStatus :: Maybe Text
- stoppedAt :: Maybe POSIX
- containers :: Maybe [Container]
- enableExecuteCommand :: Maybe Bool
- tags :: Maybe [Tag]
- pullStoppedAt :: Maybe POSIX
- ephemeralStorage :: Maybe EphemeralStorage
- lastStatus :: Maybe Text
- executionStoppedAt :: Maybe POSIX
- cpu :: Maybe Text
- healthStatus :: Maybe HealthStatus
- connectivityAt :: Maybe POSIX
- taskArn :: Maybe Text
- taskDefinitionArn :: Maybe Text
- stopCode :: Maybe TaskStopCode
- stoppedReason :: Maybe Text
- capacityProviderName :: Maybe Text
- attachments :: Maybe [Attachment]
- newTask :: Task
- task_clusterArn :: Lens' Task (Maybe Text)
- task_startedAt :: Lens' Task (Maybe UTCTime)
- task_memory :: Lens' Task (Maybe Text)
- task_pullStartedAt :: Lens' Task (Maybe UTCTime)
- task_containerInstanceArn :: Lens' Task (Maybe Text)
- task_launchType :: Lens' Task (Maybe LaunchType)
- task_createdAt :: Lens' Task (Maybe UTCTime)
- task_platformVersion :: Lens' Task (Maybe Text)
- task_connectivity :: Lens' Task (Maybe Connectivity)
- task_stoppingAt :: Lens' Task (Maybe UTCTime)
- task_startedBy :: Lens' Task (Maybe Text)
- task_version :: Lens' Task (Maybe Integer)
- task_group :: Lens' Task (Maybe Text)
- task_availabilityZone :: Lens' Task (Maybe Text)
- task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator])
- task_attributes :: Lens' Task (Maybe [Attribute])
- task_overrides :: Lens' Task (Maybe TaskOverride)
- task_desiredStatus :: Lens' Task (Maybe Text)
- task_stoppedAt :: Lens' Task (Maybe UTCTime)
- task_containers :: Lens' Task (Maybe [Container])
- task_enableExecuteCommand :: Lens' Task (Maybe Bool)
- task_tags :: Lens' Task (Maybe [Tag])
- task_pullStoppedAt :: Lens' Task (Maybe UTCTime)
- task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage)
- task_lastStatus :: Lens' Task (Maybe Text)
- task_executionStoppedAt :: Lens' Task (Maybe UTCTime)
- task_cpu :: Lens' Task (Maybe Text)
- task_healthStatus :: Lens' Task (Maybe HealthStatus)
- task_connectivityAt :: Lens' Task (Maybe UTCTime)
- task_taskArn :: Lens' Task (Maybe Text)
- task_taskDefinitionArn :: Lens' Task (Maybe Text)
- task_stopCode :: Lens' Task (Maybe TaskStopCode)
- task_stoppedReason :: Lens' Task (Maybe Text)
- task_capacityProviderName :: Lens' Task (Maybe Text)
- task_attachments :: Lens' Task (Maybe [Attachment])
- data TaskDefinition = TaskDefinition' {
- taskRoleArn :: Maybe Text
- status :: Maybe TaskDefinitionStatus
- memory :: Maybe Text
- containerDefinitions :: Maybe [ContainerDefinition]
- requiresCompatibilities :: Maybe [Compatibility]
- pidMode :: Maybe PidMode
- volumes :: Maybe [Volume]
- executionRoleArn :: Maybe Text
- compatibilities :: Maybe [Compatibility]
- registeredAt :: Maybe POSIX
- placementConstraints :: Maybe [TaskDefinitionPlacementConstraint]
- inferenceAccelerators :: Maybe [InferenceAccelerator]
- deregisteredAt :: Maybe POSIX
- proxyConfiguration :: Maybe ProxyConfiguration
- requiresAttributes :: Maybe [Attribute]
- ipcMode :: Maybe IpcMode
- family :: Maybe Text
- ephemeralStorage :: Maybe EphemeralStorage
- cpu :: Maybe Text
- registeredBy :: Maybe Text
- revision :: Maybe Int
- networkMode :: Maybe NetworkMode
- taskDefinitionArn :: Maybe Text
- newTaskDefinition :: TaskDefinition
- taskDefinition_taskRoleArn :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_status :: Lens' TaskDefinition (Maybe TaskDefinitionStatus)
- taskDefinition_memory :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_containerDefinitions :: Lens' TaskDefinition (Maybe [ContainerDefinition])
- taskDefinition_requiresCompatibilities :: Lens' TaskDefinition (Maybe [Compatibility])
- taskDefinition_pidMode :: Lens' TaskDefinition (Maybe PidMode)
- taskDefinition_volumes :: Lens' TaskDefinition (Maybe [Volume])
- taskDefinition_executionRoleArn :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_compatibilities :: Lens' TaskDefinition (Maybe [Compatibility])
- taskDefinition_registeredAt :: Lens' TaskDefinition (Maybe UTCTime)
- taskDefinition_placementConstraints :: Lens' TaskDefinition (Maybe [TaskDefinitionPlacementConstraint])
- taskDefinition_inferenceAccelerators :: Lens' TaskDefinition (Maybe [InferenceAccelerator])
- taskDefinition_deregisteredAt :: Lens' TaskDefinition (Maybe UTCTime)
- taskDefinition_proxyConfiguration :: Lens' TaskDefinition (Maybe ProxyConfiguration)
- taskDefinition_requiresAttributes :: Lens' TaskDefinition (Maybe [Attribute])
- taskDefinition_ipcMode :: Lens' TaskDefinition (Maybe IpcMode)
- taskDefinition_family :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_ephemeralStorage :: Lens' TaskDefinition (Maybe EphemeralStorage)
- taskDefinition_cpu :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_registeredBy :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_revision :: Lens' TaskDefinition (Maybe Int)
- taskDefinition_networkMode :: Lens' TaskDefinition (Maybe NetworkMode)
- taskDefinition_taskDefinitionArn :: Lens' TaskDefinition (Maybe Text)
- data TaskDefinitionPlacementConstraint = TaskDefinitionPlacementConstraint' {}
- newTaskDefinitionPlacementConstraint :: TaskDefinitionPlacementConstraint
- taskDefinitionPlacementConstraint_type :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType)
- taskDefinitionPlacementConstraint_expression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text)
- data TaskOverride = TaskOverride' {}
- newTaskOverride :: TaskOverride
- taskOverride_taskRoleArn :: Lens' TaskOverride (Maybe Text)
- taskOverride_memory :: Lens' TaskOverride (Maybe Text)
- taskOverride_inferenceAcceleratorOverrides :: Lens' TaskOverride (Maybe [InferenceAcceleratorOverride])
- taskOverride_executionRoleArn :: Lens' TaskOverride (Maybe Text)
- taskOverride_containerOverrides :: Lens' TaskOverride (Maybe [ContainerOverride])
- taskOverride_ephemeralStorage :: Lens' TaskOverride (Maybe EphemeralStorage)
- taskOverride_cpu :: Lens' TaskOverride (Maybe Text)
- data TaskSet = TaskSet' {
- clusterArn :: Maybe Text
- stabilityStatusAt :: Maybe POSIX
- runningCount :: Maybe Int
- status :: Maybe Text
- stabilityStatus :: Maybe StabilityStatus
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- networkConfiguration :: Maybe NetworkConfiguration
- updatedAt :: Maybe POSIX
- launchType :: Maybe LaunchType
- id :: Maybe Text
- createdAt :: Maybe POSIX
- platformVersion :: Maybe Text
- startedBy :: Maybe Text
- computedDesiredCount :: Maybe Int
- pendingCount :: Maybe Int
- loadBalancers :: Maybe [LoadBalancer]
- tags :: Maybe [Tag]
- serviceRegistries :: Maybe [ServiceRegistry]
- scale :: Maybe Scale
- taskDefinition :: Maybe Text
- serviceArn :: Maybe Text
- externalId :: Maybe Text
- taskSetArn :: Maybe Text
- newTaskSet :: TaskSet
- taskSet_clusterArn :: Lens' TaskSet (Maybe Text)
- taskSet_stabilityStatusAt :: Lens' TaskSet (Maybe UTCTime)
- taskSet_runningCount :: Lens' TaskSet (Maybe Int)
- taskSet_status :: Lens' TaskSet (Maybe Text)
- taskSet_stabilityStatus :: Lens' TaskSet (Maybe StabilityStatus)
- taskSet_capacityProviderStrategy :: Lens' TaskSet (Maybe [CapacityProviderStrategyItem])
- taskSet_networkConfiguration :: Lens' TaskSet (Maybe NetworkConfiguration)
- taskSet_updatedAt :: Lens' TaskSet (Maybe UTCTime)
- taskSet_launchType :: Lens' TaskSet (Maybe LaunchType)
- taskSet_id :: Lens' TaskSet (Maybe Text)
- taskSet_createdAt :: Lens' TaskSet (Maybe UTCTime)
- taskSet_platformVersion :: Lens' TaskSet (Maybe Text)
- taskSet_startedBy :: Lens' TaskSet (Maybe Text)
- taskSet_computedDesiredCount :: Lens' TaskSet (Maybe Int)
- taskSet_pendingCount :: Lens' TaskSet (Maybe Int)
- taskSet_loadBalancers :: Lens' TaskSet (Maybe [LoadBalancer])
- taskSet_tags :: Lens' TaskSet (Maybe [Tag])
- taskSet_serviceRegistries :: Lens' TaskSet (Maybe [ServiceRegistry])
- taskSet_scale :: Lens' TaskSet (Maybe Scale)
- taskSet_taskDefinition :: Lens' TaskSet (Maybe Text)
- taskSet_serviceArn :: Lens' TaskSet (Maybe Text)
- taskSet_externalId :: Lens' TaskSet (Maybe Text)
- taskSet_taskSetArn :: Lens' TaskSet (Maybe Text)
- data Tmpfs = Tmpfs' {
- mountOptions :: Maybe [Text]
- containerPath :: Text
- size :: Int
- newTmpfs :: Text -> Int -> Tmpfs
- tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text])
- tmpfs_containerPath :: Lens' Tmpfs Text
- tmpfs_size :: Lens' Tmpfs Int
- data Ulimit = Ulimit' {}
- newUlimit :: UlimitName -> Int -> Int -> Ulimit
- ulimit_name :: Lens' Ulimit UlimitName
- ulimit_softLimit :: Lens' Ulimit Int
- ulimit_hardLimit :: Lens' Ulimit Int
- data VersionInfo = VersionInfo' {}
- newVersionInfo :: VersionInfo
- versionInfo_agentVersion :: Lens' VersionInfo (Maybe Text)
- versionInfo_dockerVersion :: Lens' VersionInfo (Maybe Text)
- versionInfo_agentHash :: Lens' VersionInfo (Maybe Text)
- data Volume = Volume' {}
- newVolume :: Volume
- volume_name :: Lens' Volume (Maybe Text)
- volume_dockerVolumeConfiguration :: Lens' Volume (Maybe DockerVolumeConfiguration)
- volume_fsxWindowsFileServerVolumeConfiguration :: Lens' Volume (Maybe FSxWindowsFileServerVolumeConfiguration)
- volume_host :: Lens' Volume (Maybe HostVolumeProperties)
- volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration)
- data VolumeFrom = VolumeFrom' {}
- newVolumeFrom :: VolumeFrom
- volumeFrom_readOnly :: Lens' VolumeFrom (Maybe Bool)
- volumeFrom_sourceContainer :: Lens' VolumeFrom (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2014-11-13 of the Amazon EC2 Container Service SDK configuration.
Errors
_UpdateInProgressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is already a current Amazon ECS container agent update in progress
on the specified container instance. If the container agent becomes
disconnected while it is in a transitional stage, such as PENDING or
STAGING, the update process can get stuck in that state. However, when
the agent reconnects, it resumes where it stopped previously.
_TargetNotConnectedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The target container is not properly configured with the execute command agent or the container is no longer active or running.
_PlatformTaskDefinitionIncompatibilityException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified platform version does not satisfy the task definition's required capabilities.
_ServiceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
_UnsupportedFeatureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified task is not supported in this Region.
_TaskSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified task set could not be found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
_ClusterContainsContainerInstancesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
_ClusterContainsServicesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.
_PlatformUnknownException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified platform version does not exist.
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified parameter is invalid. Review the available parameters for the API request.
_BlockedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your Amazon Web Services account has been blocked. For more information, contact Amazon Web Services Support.
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have authorization to perform the requested action.
_MissingVersionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit for the resource has been exceeded.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is in-use and cannot be removed.
_ClusterNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource could not be found.
_ClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
_NoUpdateAvailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.
_ServiceNotActiveException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
_ClusterContainsTasksException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You cannot delete a cluster that has active tasks.
_AttributeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
_TargetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
_ServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
These errors are usually caused by a server issue.
AgentUpdateStatus
newtype AgentUpdateStatus Source #
Constructors
| AgentUpdateStatus' | |
Fields | |
Bundled Patterns
| pattern AgentUpdateStatus_FAILED :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_PENDING :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_STAGED :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_STAGING :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_UPDATED :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_UPDATING :: AgentUpdateStatus |
Instances
AssignPublicIp
newtype AssignPublicIp Source #
Constructors
| AssignPublicIp' | |
Fields | |
Bundled Patterns
| pattern AssignPublicIp_DISABLED :: AssignPublicIp | |
| pattern AssignPublicIp_ENABLED :: AssignPublicIp |
Instances
CapacityProviderField
newtype CapacityProviderField Source #
Constructors
| CapacityProviderField' | |
Fields | |
Bundled Patterns
| pattern CapacityProviderField_TAGS :: CapacityProviderField |
Instances
CapacityProviderStatus
newtype CapacityProviderStatus Source #
Constructors
| CapacityProviderStatus' | |
Fields | |
Bundled Patterns
| pattern CapacityProviderStatus_ACTIVE :: CapacityProviderStatus | |
| pattern CapacityProviderStatus_INACTIVE :: CapacityProviderStatus |
Instances
CapacityProviderUpdateStatus
newtype CapacityProviderUpdateStatus Source #
Constructors
| CapacityProviderUpdateStatus' | |
Fields | |
Bundled Patterns
Instances
ClusterField
newtype ClusterField Source #
Constructors
| ClusterField' | |
Fields | |
Bundled Patterns
| pattern ClusterField_ATTACHMENTS :: ClusterField | |
| pattern ClusterField_CONFIGURATIONS :: ClusterField | |
| pattern ClusterField_SETTINGS :: ClusterField | |
| pattern ClusterField_STATISTICS :: ClusterField | |
| pattern ClusterField_TAGS :: ClusterField |
Instances
ClusterSettingName
newtype ClusterSettingName Source #
Constructors
| ClusterSettingName' | |
Fields | |
Bundled Patterns
| pattern ClusterSettingName_ContainerInsights :: ClusterSettingName |
Instances
Compatibility
newtype Compatibility Source #
Constructors
| Compatibility' | |
Fields | |
Bundled Patterns
| pattern Compatibility_EC2 :: Compatibility | |
| pattern Compatibility_EXTERNAL :: Compatibility | |
| pattern Compatibility_FARGATE :: Compatibility |
Instances
Connectivity
newtype Connectivity Source #
Constructors
| Connectivity' | |
Fields | |
Bundled Patterns
| pattern Connectivity_CONNECTED :: Connectivity | |
| pattern Connectivity_DISCONNECTED :: Connectivity |
Instances
ContainerCondition
newtype ContainerCondition Source #
Constructors
| ContainerCondition' | |
Fields | |
Bundled Patterns
| pattern ContainerCondition_COMPLETE :: ContainerCondition | |
| pattern ContainerCondition_HEALTHY :: ContainerCondition | |
| pattern ContainerCondition_START :: ContainerCondition | |
| pattern ContainerCondition_SUCCESS :: ContainerCondition |
Instances
ContainerInstanceField
newtype ContainerInstanceField Source #
Constructors
| ContainerInstanceField' | |
Fields | |
Bundled Patterns
| pattern ContainerInstanceField_TAGS :: ContainerInstanceField |
Instances
ContainerInstanceStatus
newtype ContainerInstanceStatus Source #
Constructors
| ContainerInstanceStatus' | |
Fields | |
Bundled Patterns
Instances
DeploymentControllerType
newtype DeploymentControllerType Source #
Constructors
| DeploymentControllerType' | |
Fields | |
Bundled Patterns
Instances
DeploymentRolloutState
newtype DeploymentRolloutState Source #
Constructors
| DeploymentRolloutState' | |
Fields | |
Bundled Patterns
| pattern DeploymentRolloutState_COMPLETED :: DeploymentRolloutState | |
| pattern DeploymentRolloutState_FAILED :: DeploymentRolloutState | |
| pattern DeploymentRolloutState_IN_PROGRESS :: DeploymentRolloutState |
Instances
DesiredStatus
newtype DesiredStatus Source #
Constructors
| DesiredStatus' | |
Fields | |
Bundled Patterns
| pattern DesiredStatus_PENDING :: DesiredStatus | |
| pattern DesiredStatus_RUNNING :: DesiredStatus | |
| pattern DesiredStatus_STOPPED :: DesiredStatus |
Instances
DeviceCgroupPermission
newtype DeviceCgroupPermission Source #
Constructors
| DeviceCgroupPermission' | |
Fields | |
Bundled Patterns
| pattern DeviceCgroupPermission_Mknod :: DeviceCgroupPermission | |
| pattern DeviceCgroupPermission_Read :: DeviceCgroupPermission | |
| pattern DeviceCgroupPermission_Write :: DeviceCgroupPermission |
Instances
EFSAuthorizationConfigIAM
newtype EFSAuthorizationConfigIAM Source #
Constructors
| EFSAuthorizationConfigIAM' | |
Fields | |
Bundled Patterns
| pattern EFSAuthorizationConfigIAM_DISABLED :: EFSAuthorizationConfigIAM | |
| pattern EFSAuthorizationConfigIAM_ENABLED :: EFSAuthorizationConfigIAM |
Instances
EFSTransitEncryption
newtype EFSTransitEncryption Source #
Constructors
| EFSTransitEncryption' | |
Fields | |
Bundled Patterns
| pattern EFSTransitEncryption_DISABLED :: EFSTransitEncryption | |
| pattern EFSTransitEncryption_ENABLED :: EFSTransitEncryption |
Instances
EnvironmentFileType
newtype EnvironmentFileType Source #
Constructors
| EnvironmentFileType' | |
Fields | |
Bundled Patterns
| pattern EnvironmentFileType_S3 :: EnvironmentFileType |
Instances
ExecuteCommandLogging
newtype ExecuteCommandLogging Source #
Constructors
| ExecuteCommandLogging' | |
Fields | |
Bundled Patterns
| pattern ExecuteCommandLogging_DEFAULT :: ExecuteCommandLogging | |
| pattern ExecuteCommandLogging_NONE :: ExecuteCommandLogging | |
| pattern ExecuteCommandLogging_OVERRIDE :: ExecuteCommandLogging |
Instances
FirelensConfigurationType
newtype FirelensConfigurationType Source #
Constructors
| FirelensConfigurationType' | |
Fields | |
Bundled Patterns
| pattern FirelensConfigurationType_Fluentbit :: FirelensConfigurationType | |
| pattern FirelensConfigurationType_Fluentd :: FirelensConfigurationType |
Instances
HealthStatus
newtype HealthStatus Source #
Constructors
| HealthStatus' | |
Fields | |
Bundled Patterns
| pattern HealthStatus_HEALTHY :: HealthStatus | |
| pattern HealthStatus_UNHEALTHY :: HealthStatus | |
| pattern HealthStatus_UNKNOWN :: HealthStatus |
Instances
IpcMode
Constructors
| IpcMode' | |
Fields
| |
Bundled Patterns
| pattern IpcMode_Host :: IpcMode | |
| pattern IpcMode_None :: IpcMode | |
| pattern IpcMode_Task :: IpcMode |
Instances
LaunchType
newtype LaunchType Source #
Constructors
| LaunchType' | |
Fields | |
Bundled Patterns
| pattern LaunchType_EC2 :: LaunchType | |
| pattern LaunchType_EXTERNAL :: LaunchType | |
| pattern LaunchType_FARGATE :: LaunchType |
Instances
LogDriver
Constructors
| LogDriver' | |
Fields | |
Bundled Patterns
| pattern LogDriver_Awsfirelens :: LogDriver | |
| pattern LogDriver_Awslogs :: LogDriver | |
| pattern LogDriver_Fluentd :: LogDriver | |
| pattern LogDriver_Gelf :: LogDriver | |
| pattern LogDriver_Journald :: LogDriver | |
| pattern LogDriver_Json_file :: LogDriver | |
| pattern LogDriver_Splunk :: LogDriver | |
| pattern LogDriver_Syslog :: LogDriver |
Instances
ManagedAgentName
newtype ManagedAgentName Source #
Constructors
| ManagedAgentName' | |
Fields | |
Bundled Patterns
| pattern ManagedAgentName_ExecuteCommandAgent :: ManagedAgentName |
Instances
ManagedScalingStatus
newtype ManagedScalingStatus Source #
Constructors
| ManagedScalingStatus' | |
Fields | |
Bundled Patterns
| pattern ManagedScalingStatus_DISABLED :: ManagedScalingStatus | |
| pattern ManagedScalingStatus_ENABLED :: ManagedScalingStatus |
Instances
ManagedTerminationProtection
newtype ManagedTerminationProtection Source #
Constructors
| ManagedTerminationProtection' | |
Fields | |
Bundled Patterns
| pattern ManagedTerminationProtection_DISABLED :: ManagedTerminationProtection | |
| pattern ManagedTerminationProtection_ENABLED :: ManagedTerminationProtection |
Instances
NetworkMode
newtype NetworkMode Source #
Constructors
| NetworkMode' | |
Fields | |
Bundled Patterns
| pattern NetworkMode_Awsvpc :: NetworkMode | |
| pattern NetworkMode_Bridge :: NetworkMode | |
| pattern NetworkMode_Host :: NetworkMode | |
| pattern NetworkMode_None :: NetworkMode |
Instances
PidMode
Constructors
| PidMode' | |
Fields
| |
Bundled Patterns
| pattern PidMode_Host :: PidMode | |
| pattern PidMode_Task :: PidMode |
Instances
PlacementConstraintType
newtype PlacementConstraintType Source #
Constructors
| PlacementConstraintType' | |
Fields | |
Bundled Patterns
| pattern PlacementConstraintType_DistinctInstance :: PlacementConstraintType | |
| pattern PlacementConstraintType_MemberOf :: PlacementConstraintType |
Instances
PlacementStrategyType
newtype PlacementStrategyType Source #
Constructors
| PlacementStrategyType' | |
Fields | |
Bundled Patterns
| pattern PlacementStrategyType_Binpack :: PlacementStrategyType | |
| pattern PlacementStrategyType_Random :: PlacementStrategyType | |
| pattern PlacementStrategyType_Spread :: PlacementStrategyType |
Instances
PlatformDeviceType
newtype PlatformDeviceType Source #
Constructors
| PlatformDeviceType' | |
Fields | |
Bundled Patterns
| pattern PlatformDeviceType_GPU :: PlatformDeviceType |
Instances
PropagateTags
newtype PropagateTags Source #
Constructors
| PropagateTags' | |
Fields | |
Bundled Patterns
| pattern PropagateTags_SERVICE :: PropagateTags | |
| pattern PropagateTags_TASK_DEFINITION :: PropagateTags |
Instances
ProxyConfigurationType
newtype ProxyConfigurationType Source #
Constructors
| ProxyConfigurationType' | |
Fields | |
Bundled Patterns
| pattern ProxyConfigurationType_APPMESH :: ProxyConfigurationType |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_GPU :: ResourceType | |
| pattern ResourceType_InferenceAccelerator :: ResourceType |
Instances
ScaleUnit
Constructors
| ScaleUnit' | |
Fields | |
Bundled Patterns
| pattern ScaleUnit_PERCENT :: ScaleUnit |
Instances
SchedulingStrategy
newtype SchedulingStrategy Source #
Constructors
| SchedulingStrategy' | |
Fields | |
Bundled Patterns
| pattern SchedulingStrategy_DAEMON :: SchedulingStrategy | |
| pattern SchedulingStrategy_REPLICA :: SchedulingStrategy |
Instances
Scope
Bundled Patterns
| pattern Scope_Shared :: Scope | |
| pattern Scope_Task :: Scope |
Instances
ServiceField
newtype ServiceField Source #
Constructors
| ServiceField' | |
Fields | |
Bundled Patterns
| pattern ServiceField_TAGS :: ServiceField |
Instances
SettingName
newtype SettingName Source #
Constructors
| SettingName' | |
Fields | |
Bundled Patterns
| pattern SettingName_AwsvpcTrunking :: SettingName | |
| pattern SettingName_ContainerInsights :: SettingName | |
| pattern SettingName_ContainerInstanceLongArnFormat :: SettingName | |
| pattern SettingName_ServiceLongArnFormat :: SettingName | |
| pattern SettingName_TaskLongArnFormat :: SettingName |
Instances
SortOrder
Constructors
| SortOrder' | |
Fields | |
Bundled Patterns
| pattern SortOrder_ASC :: SortOrder | |
| pattern SortOrder_DESC :: SortOrder |
Instances
StabilityStatus
newtype StabilityStatus Source #
Constructors
| StabilityStatus' | |
Fields | |
Bundled Patterns
| pattern StabilityStatus_STABILIZING :: StabilityStatus | |
| pattern StabilityStatus_STEADY_STATE :: StabilityStatus |
Instances
TargetType
newtype TargetType Source #
Constructors
| TargetType' | |
Fields | |
Bundled Patterns
| pattern TargetType_Container_instance :: TargetType |
Instances
TaskDefinitionFamilyStatus
newtype TaskDefinitionFamilyStatus Source #
Constructors
| TaskDefinitionFamilyStatus' | |
Fields | |
Bundled Patterns
Instances
TaskDefinitionField
newtype TaskDefinitionField Source #
Constructors
| TaskDefinitionField' | |
Fields | |
Bundled Patterns
| pattern TaskDefinitionField_TAGS :: TaskDefinitionField |
Instances
TaskDefinitionPlacementConstraintType
newtype TaskDefinitionPlacementConstraintType Source #
Constructors
| TaskDefinitionPlacementConstraintType' | |
Bundled Patterns
| pattern TaskDefinitionPlacementConstraintType_MemberOf :: TaskDefinitionPlacementConstraintType |
Instances
TaskDefinitionStatus
newtype TaskDefinitionStatus Source #
Constructors
| TaskDefinitionStatus' | |
Fields | |
Bundled Patterns
| pattern TaskDefinitionStatus_ACTIVE :: TaskDefinitionStatus | |
| pattern TaskDefinitionStatus_INACTIVE :: TaskDefinitionStatus |
Instances
TaskField
Constructors
| TaskField' | |
Fields | |
Bundled Patterns
| pattern TaskField_TAGS :: TaskField |
Instances
TaskSetField
newtype TaskSetField Source #
Constructors
| TaskSetField' | |
Fields | |
Bundled Patterns
| pattern TaskSetField_TAGS :: TaskSetField |
Instances
TaskStopCode
newtype TaskStopCode Source #
Constructors
| TaskStopCode' | |
Fields | |
Bundled Patterns
| pattern TaskStopCode_EssentialContainerExited :: TaskStopCode | |
| pattern TaskStopCode_TaskFailedToStart :: TaskStopCode | |
| pattern TaskStopCode_UserInitiated :: TaskStopCode |
Instances
TransportProtocol
newtype TransportProtocol Source #
Constructors
| TransportProtocol' | |
Fields | |
Bundled Patterns
| pattern TransportProtocol_Tcp :: TransportProtocol | |
| pattern TransportProtocol_Udp :: TransportProtocol |
Instances
UlimitName
newtype UlimitName Source #
Constructors
| UlimitName' | |
Fields | |
Bundled Patterns
| pattern UlimitName_Core :: UlimitName | |
| pattern UlimitName_Cpu :: UlimitName | |
| pattern UlimitName_Data :: UlimitName | |
| pattern UlimitName_Fsize :: UlimitName | |
| pattern UlimitName_Locks :: UlimitName | |
| pattern UlimitName_Memlock :: UlimitName | |
| pattern UlimitName_Msgqueue :: UlimitName | |
| pattern UlimitName_Nice :: UlimitName | |
| pattern UlimitName_Nofile :: UlimitName | |
| pattern UlimitName_Nproc :: UlimitName | |
| pattern UlimitName_Rss :: UlimitName | |
| pattern UlimitName_Rtprio :: UlimitName | |
| pattern UlimitName_Rttime :: UlimitName | |
| pattern UlimitName_Sigpending :: UlimitName | |
| pattern UlimitName_Stack :: UlimitName |
Instances
Attachment
data Attachment Source #
An object representing a container instance or task attachment.
See: newAttachment smart constructor.
Constructors
| Attachment' | |
Fields
| |
Instances
newAttachment :: Attachment Source #
Create a value of Attachment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:Attachment', attachment_status - The status of the attachment. Valid values are PRECREATED, CREATED,
ATTACHING, ATTACHED, DETACHING, DETACHED, and DELETED.
$sel:id:Attachment', attachment_id - The unique identifier for the attachment.
$sel:details:Attachment', attachment_details - Details of the attachment. For elastic network interfaces, this includes
the network interface ID, the MAC address, the subnet ID, and the
private IPv4 address.
$sel:type':Attachment', attachment_type - The type of the attachment, such as ElasticNetworkInterface.
attachment_status :: Lens' Attachment (Maybe Text) Source #
The status of the attachment. Valid values are PRECREATED, CREATED,
ATTACHING, ATTACHED, DETACHING, DETACHED, and DELETED.
attachment_id :: Lens' Attachment (Maybe Text) Source #
The unique identifier for the attachment.
attachment_details :: Lens' Attachment (Maybe [KeyValuePair]) Source #
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
attachment_type :: Lens' Attachment (Maybe Text) Source #
The type of the attachment, such as ElasticNetworkInterface.
AttachmentStateChange
data AttachmentStateChange Source #
An object representing a change in state for a task attachment.
See: newAttachmentStateChange smart constructor.
Constructors
| AttachmentStateChange' | |
Fields
| |
Instances
newAttachmentStateChange Source #
Arguments
| :: Text | |
| -> Text | |
| -> AttachmentStateChange |
Create a value of AttachmentStateChange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachmentArn:AttachmentStateChange', attachmentStateChange_attachmentArn - The Amazon Resource Name (ARN) of the attachment.
$sel:status:AttachmentStateChange', attachmentStateChange_status - The status of the attachment.
attachmentStateChange_attachmentArn :: Lens' AttachmentStateChange Text Source #
The Amazon Resource Name (ARN) of the attachment.
attachmentStateChange_status :: Lens' AttachmentStateChange Text Source #
The status of the attachment.
Attribute
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
See: newAttribute smart constructor.
Constructors
| Attribute' | |
Fields
| |
Instances
Create a value of Attribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetId:Attribute', attribute_targetId - The ID of the target. You can specify the short form ID for a resource
or the full Amazon Resource Name (ARN).
$sel:targetType:Attribute', attribute_targetType - The type of the target with which to attach the attribute. This
parameter is required if you use the short form ID for a resource
instead of the full ARN.
$sel:value:Attribute', attribute_value - The value of the attribute. The value must contain between 1 and 128
characters and may contain letters (uppercase and lowercase), numbers,
hyphens, underscores, periods, at signs (@), forward slashes, back
slashes, colons, or spaces. The value cannot contain any leading or
trailing whitespace.
$sel:name:Attribute', attribute_name - The name of the attribute. The name must contain between 1 and 128
characters and name may contain letters (uppercase and lowercase),
numbers, hyphens, underscores, forward slashes, back slashes, or
periods.
attribute_targetId :: Lens' Attribute (Maybe Text) Source #
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
attribute_targetType :: Lens' Attribute (Maybe TargetType) Source #
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
attribute_value :: Lens' Attribute (Maybe Text) Source #
The value of the attribute. The value must contain between 1 and 128
characters and may contain letters (uppercase and lowercase), numbers,
hyphens, underscores, periods, at signs (@), forward slashes, back
slashes, colons, or spaces. The value cannot contain any leading or
trailing whitespace.
attribute_name :: Lens' Attribute Text Source #
The name of the attribute. The name must contain between 1 and 128
characters and name may contain letters (uppercase and lowercase),
numbers, hyphens, underscores, forward slashes, back slashes, or
periods.
AutoScalingGroupProvider
data AutoScalingGroupProvider Source #
The details of the Auto Scaling group for the capacity provider.
See: newAutoScalingGroupProvider smart constructor.
Constructors
| AutoScalingGroupProvider' | |
Fields
| |
Instances
newAutoScalingGroupProvider Source #
Create a value of AutoScalingGroupProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:managedScaling:AutoScalingGroupProvider', autoScalingGroupProvider_managedScaling - The managed scaling settings for the Auto Scaling group capacity
provider.
$sel:managedTerminationProtection:AutoScalingGroupProvider', autoScalingGroupProvider_managedTerminationProtection - The managed termination protection setting to use for the Auto Scaling
group capacity provider. This determines whether the Auto Scaling group
has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
$sel:autoScalingGroupArn:AutoScalingGroupProvider', autoScalingGroupProvider_autoScalingGroupArn - The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
autoScalingGroupProvider_managedScaling :: Lens' AutoScalingGroupProvider (Maybe ManagedScaling) Source #
The managed scaling settings for the Auto Scaling group capacity provider.
autoScalingGroupProvider_managedTerminationProtection :: Lens' AutoScalingGroupProvider (Maybe ManagedTerminationProtection) Source #
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
autoScalingGroupProvider_autoScalingGroupArn :: Lens' AutoScalingGroupProvider Text Source #
The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
AutoScalingGroupProviderUpdate
data AutoScalingGroupProviderUpdate Source #
The details of the Auto Scaling group capacity provider to update.
See: newAutoScalingGroupProviderUpdate smart constructor.
Constructors
| AutoScalingGroupProviderUpdate' | |
Fields
| |
Instances
newAutoScalingGroupProviderUpdate :: AutoScalingGroupProviderUpdate Source #
Create a value of AutoScalingGroupProviderUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:managedScaling:AutoScalingGroupProviderUpdate', autoScalingGroupProviderUpdate_managedScaling - The managed scaling settings for the Auto Scaling group capacity
provider.
$sel:managedTerminationProtection:AutoScalingGroupProviderUpdate', autoScalingGroupProviderUpdate_managedTerminationProtection - The managed termination protection setting to use for the Auto Scaling
group capacity provider. This determines whether the Auto Scaling group
has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
autoScalingGroupProviderUpdate_managedScaling :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedScaling) Source #
The managed scaling settings for the Auto Scaling group capacity provider.
autoScalingGroupProviderUpdate_managedTerminationProtection :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedTerminationProtection) Source #
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
AwsVpcConfiguration
data AwsVpcConfiguration Source #
An object representing the networking details for a task or service.
See: newAwsVpcConfiguration smart constructor.
Constructors
| AwsVpcConfiguration' | |
Fields
| |
Instances
newAwsVpcConfiguration :: AwsVpcConfiguration Source #
Create a value of AwsVpcConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignPublicIp:AwsVpcConfiguration', awsVpcConfiguration_assignPublicIp - Whether the task's elastic network interface receives a public IP
address. The default value is DISABLED.
$sel:securityGroups:AwsVpcConfiguration', awsVpcConfiguration_securityGroups - The IDs of the security groups associated with the task or service. If
you do not specify a security group, the default security group for the
VPC is used. There is a limit of 5 security groups that can be specified
per AwsVpcConfiguration.
All specified security groups must be from the same VPC.
$sel:subnets:AwsVpcConfiguration', awsVpcConfiguration_subnets - The IDs of the subnets associated with the task or service. There is a
limit of 16 subnets that can be specified per AwsVpcConfiguration.
All specified subnets must be from the same VPC.
awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp) Source #
Whether the task's elastic network interface receives a public IP
address. The default value is DISABLED.
awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text]) Source #
The IDs of the security groups associated with the task or service. If
you do not specify a security group, the default security group for the
VPC is used. There is a limit of 5 security groups that can be specified
per AwsVpcConfiguration.
All specified security groups must be from the same VPC.
awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text] Source #
The IDs of the subnets associated with the task or service. There is a
limit of 16 subnets that can be specified per AwsVpcConfiguration.
All specified subnets must be from the same VPC.
CapacityProvider
data CapacityProvider Source #
The details of a capacity provider.
See: newCapacityProvider smart constructor.
Constructors
| CapacityProvider' | |
Fields
| |
Instances
newCapacityProvider :: CapacityProvider Source #
Create a value of CapacityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:CapacityProvider', capacityProvider_status - The current status of the capacity provider. Only capacity providers in
an ACTIVE state can be used in a cluster. When a capacity provider is
successfully deleted, it will have an INACTIVE status.
$sel:updateStatusReason:CapacityProvider', capacityProvider_updateStatusReason - The update status reason. This provides further details about the update
status for the capacity provider.
$sel:capacityProviderArn:CapacityProvider', capacityProvider_capacityProviderArn - The Amazon Resource Name (ARN) that identifies the capacity provider.
$sel:updateStatus:CapacityProvider', capacityProvider_updateStatus - The update status of the capacity provider. The following are the
possible states that will be returned.
- DELETE_IN_PROGRESS
- The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
- The capacity provider has been successfully deleted and will have an
INACTIVEstatus. - DELETE_FAILED
- The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
$sel:name:CapacityProvider', capacityProvider_name - The name of the capacity provider.
$sel:autoScalingGroupProvider:CapacityProvider', capacityProvider_autoScalingGroupProvider - The Auto Scaling group settings for the capacity provider.
$sel:tags:CapacityProvider', capacityProvider_tags - The metadata that you apply to the capacity provider to help you
categorize and organize it. Each tag consists of a key and an optional
value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
capacityProvider_status :: Lens' CapacityProvider (Maybe CapacityProviderStatus) Source #
The current status of the capacity provider. Only capacity providers in
an ACTIVE state can be used in a cluster. When a capacity provider is
successfully deleted, it will have an INACTIVE status.
capacityProvider_updateStatusReason :: Lens' CapacityProvider (Maybe Text) Source #
The update status reason. This provides further details about the update status for the capacity provider.
capacityProvider_capacityProviderArn :: Lens' CapacityProvider (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the capacity provider.
capacityProvider_updateStatus :: Lens' CapacityProvider (Maybe CapacityProviderUpdateStatus) Source #
The update status of the capacity provider. The following are the possible states that will be returned.
- DELETE_IN_PROGRESS
- The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
- The capacity provider has been successfully deleted and will have an
INACTIVEstatus. - DELETE_FAILED
- The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
capacityProvider_name :: Lens' CapacityProvider (Maybe Text) Source #
The name of the capacity provider.
capacityProvider_autoScalingGroupProvider :: Lens' CapacityProvider (Maybe AutoScalingGroupProvider) Source #
The Auto Scaling group settings for the capacity provider.
capacityProvider_tags :: Lens' CapacityProvider (Maybe [Tag]) Source #
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
CapacityProviderStrategyItem
data CapacityProviderStrategyItem Source #
The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and
have an ACTIVE or UPDATING status can be used in a capacity provider
strategy. The PutClusterCapacityProviders API is used to associate a
capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or
FARGATE_SPOT capacity providers. The Fargate capacity providers are
available to all accounts and only need to be associated with a cluster
to be used in a capacity provider strategy.
A capacity provider strategy may contain a maximum of 6 capacity providers.
See: newCapacityProviderStrategyItem smart constructor.
Constructors
| CapacityProviderStrategyItem' | |
Fields
| |
Instances
newCapacityProviderStrategyItem Source #
Create a value of CapacityProviderStrategyItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:weight:CapacityProviderStrategyItem', capacityProviderStrategyItem_weight - The weight value designates the relative percentage of the total
number of tasks launched that should use the specified capacity
provider. The weight value is taken into consideration after the
base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used.
When multiple capacity providers are specified within a capacity
provider strategy, at least one of the capacity providers must have a
weight value greater than zero and any capacity providers with a weight
of 0 will not be used to place tasks. If you specify multiple capacity
providers in a strategy that all have a weight of 0, any RunTask or
CreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that
contains two capacity providers and both have a weight of 1, then when
the base is satisfied, the tasks will be split evenly across the two
capacity providers. Using that same logic, if you specify a weight of
1 for capacityProviderA and a weight of 4 for capacityProviderB,
then for every one task that is run using capacityProviderA, four
tasks would use capacityProviderB.
$sel:base:CapacityProviderStrategyItem', capacityProviderStrategyItem_base - The base value designates how many tasks, at a minimum, to run on the
specified capacity provider. Only one capacity provider in a capacity
provider strategy can have a base defined. If no value is specified,
the default value of 0 is used.
$sel:capacityProvider:CapacityProviderStrategyItem', capacityProviderStrategyItem_capacityProvider - The short name of the capacity provider.
capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #
The weight value designates the relative percentage of the total
number of tasks launched that should use the specified capacity
provider. The weight value is taken into consideration after the
base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used.
When multiple capacity providers are specified within a capacity
provider strategy, at least one of the capacity providers must have a
weight value greater than zero and any capacity providers with a weight
of 0 will not be used to place tasks. If you specify multiple capacity
providers in a strategy that all have a weight of 0, any RunTask or
CreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that
contains two capacity providers and both have a weight of 1, then when
the base is satisfied, the tasks will be split evenly across the two
capacity providers. Using that same logic, if you specify a weight of
1 for capacityProviderA and a weight of 4 for capacityProviderB,
then for every one task that is run using capacityProviderA, four
tasks would use capacityProviderB.
capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #
The base value designates how many tasks, at a minimum, to run on the
specified capacity provider. Only one capacity provider in a capacity
provider strategy can have a base defined. If no value is specified,
the default value of 0 is used.
capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text Source #
The short name of the capacity provider.
Cluster
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
See: newCluster smart constructor.
Constructors
| Cluster' | |
Fields
| |
Instances
newCluster :: Cluster Source #
Create a value of Cluster with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterArn:Cluster', cluster_clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. The ARN
contains the arn:aws:ecs namespace, followed by the Region of the
cluster, the Amazon Web Services account ID of the cluster owner, the
cluster namespace, and then the cluster name. For example,
arn:aws:ecs:region:012345678910:cluster/test.
$sel:status:Cluster', cluster_status - The status of the cluster. The following are the possible states that
will be returned.
- ACTIVE
- The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
- PROVISIONING
- The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
- The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
- The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
- The cluster has been deleted. Clusters with an
INACTIVEstatus may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely onINACTIVEclusters persisting.
$sel:activeServicesCount:Cluster', cluster_activeServicesCount - The number of services that are running on the cluster in an ACTIVE
state. You can view these services with ListServices.
$sel:registeredContainerInstancesCount:Cluster', cluster_registeredContainerInstancesCount - The number of container instances registered into the cluster. This
includes container instances in both ACTIVE and DRAINING status.
$sel:configuration:Cluster', cluster_configuration - The execute command configuration for the cluster.
$sel:statistics:Cluster', cluster_statistics - Additional information about your clusters that are separated by launch
type, including:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
$sel:defaultCapacityProviderStrategy:Cluster', cluster_defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. When services or
tasks are run in the cluster with no launch type or capacity provider
strategy specified, the default capacity provider strategy is used.
$sel:pendingTasksCount:Cluster', cluster_pendingTasksCount - The number of tasks in the cluster that are in the PENDING state.
$sel:tags:Cluster', cluster_tags - The metadata that you apply to the cluster to help you categorize and
organize them. Each tag consists of a key and an optional value, both of
which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
$sel:capacityProviders:Cluster', cluster_capacityProviders - The capacity providers associated with the cluster.
$sel:attachmentsStatus:Cluster', cluster_attachmentsStatus - The status of the capacity providers associated with the cluster. The
following are the states that will be returned:
- UPDATE_IN_PROGRESS
- The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
- UPDATE_COMPLETE
- The capacity providers have successfully updated.
- UPDATE_FAILED
- The capacity provider updates failed.
$sel:clusterName:Cluster', cluster_clusterName - A user-generated string that you use to identify your cluster.
$sel:settings:Cluster', cluster_settings - The settings for the cluster. This parameter indicates whether
CloudWatch Container Insights is enabled or disabled for a cluster.
$sel:runningTasksCount:Cluster', cluster_runningTasksCount - The number of tasks in the cluster that are in the RUNNING state.
$sel:attachments:Cluster', cluster_attachments - The resources attached to a cluster. When using a capacity provider with
a cluster, the Auto Scaling plan that is created will be returned as a
cluster attachment.
cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the cluster. The ARN
contains the arn:aws:ecs namespace, followed by the Region of the
cluster, the Amazon Web Services account ID of the cluster owner, the
cluster namespace, and then the cluster name. For example,
arn:aws:ecs:region:012345678910:cluster/test.
cluster_status :: Lens' Cluster (Maybe Text) Source #
The status of the cluster. The following are the possible states that will be returned.
- ACTIVE
- The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
- PROVISIONING
- The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
- The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
- The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
- The cluster has been deleted. Clusters with an
INACTIVEstatus may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely onINACTIVEclusters persisting.
cluster_activeServicesCount :: Lens' Cluster (Maybe Int) Source #
The number of services that are running on the cluster in an ACTIVE
state. You can view these services with ListServices.
cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int) Source #
The number of container instances registered into the cluster. This
includes container instances in both ACTIVE and DRAINING status.
cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration) Source #
The execute command configuration for the cluster.
cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair]) Source #
Additional information about your clusters that are separated by launch type, including:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem]) Source #
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
cluster_pendingTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the PENDING state.
cluster_tags :: Lens' Cluster (Maybe [Tag]) Source #
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
cluster_capacityProviders :: Lens' Cluster (Maybe [Text]) Source #
The capacity providers associated with the cluster.
cluster_attachmentsStatus :: Lens' Cluster (Maybe Text) Source #
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
- UPDATE_IN_PROGRESS
- The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
- UPDATE_COMPLETE
- The capacity providers have successfully updated.
- UPDATE_FAILED
- The capacity provider updates failed.
cluster_clusterName :: Lens' Cluster (Maybe Text) Source #
A user-generated string that you use to identify your cluster.
cluster_settings :: Lens' Cluster (Maybe [ClusterSetting]) Source #
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
cluster_runningTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING state.
cluster_attachments :: Lens' Cluster (Maybe [Attachment]) Source #
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
ClusterConfiguration
data ClusterConfiguration Source #
The execute command configuration for the cluster.
See: newClusterConfiguration smart constructor.
Constructors
| ClusterConfiguration' | |
Fields
| |
Instances
newClusterConfiguration :: ClusterConfiguration Source #
Create a value of ClusterConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:executeCommandConfiguration:ClusterConfiguration', clusterConfiguration_executeCommandConfiguration - The details of the execute command configuration.
clusterConfiguration_executeCommandConfiguration :: Lens' ClusterConfiguration (Maybe ExecuteCommandConfiguration) Source #
The details of the execute command configuration.
ClusterSetting
data ClusterSetting Source #
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
See: newClusterSetting smart constructor.
Constructors
| ClusterSetting' | |
Fields
| |
Instances
newClusterSetting :: ClusterSetting Source #
Create a value of ClusterSetting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ClusterSetting', clusterSetting_name - The name of the cluster setting. The only supported value is
containerInsights.
$sel:value:ClusterSetting', clusterSetting_value - The value to set for the cluster setting. The supported values are
enabled and disabled. If enabled is specified, CloudWatch
Container Insights will be enabled for the cluster, otherwise it will be
disabled unless the containerInsights account setting is enabled. If a
cluster value is specified, it will override the containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
clusterSetting_name :: Lens' ClusterSetting (Maybe ClusterSettingName) Source #
The name of the cluster setting. The only supported value is
containerInsights.
clusterSetting_value :: Lens' ClusterSetting (Maybe Text) Source #
The value to set for the cluster setting. The supported values are
enabled and disabled. If enabled is specified, CloudWatch
Container Insights will be enabled for the cluster, otherwise it will be
disabled unless the containerInsights account setting is enabled. If a
cluster value is specified, it will override the containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
Container
A Docker container that is part of a task.
See: newContainer smart constructor.
Constructors
| Container' | |
Fields
| |
Instances
newContainer :: Container Source #
Create a value of Container with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageDigest:Container', container_imageDigest - The container image manifest digest.
The imageDigest is only returned if the container is using an image
hosted in Amazon ECR, otherwise it is omitted.
$sel:gpuIds:Container', container_gpuIds - The IDs of each GPU assigned to the container.
$sel:memoryReservation:Container', container_memoryReservation - The soft limit (in MiB) of memory set for the container.
$sel:memory:Container', container_memory - The hard limit (in MiB) of memory set for the container.
$sel:runtimeId:Container', container_runtimeId - The ID of the Docker container.
$sel:exitCode:Container', container_exitCode - The exit code returned from the container.
$sel:containerArn:Container', container_containerArn - The Amazon Resource Name (ARN) of the container.
$sel:name:Container', container_name - The name of the container.
$sel:image:Container', container_image - The image used for the container.
$sel:managedAgents:Container', container_managedAgents - The details of any Amazon ECS managed agents associated with the
container.
$sel:networkBindings:Container', container_networkBindings - The network bindings associated with the container.
$sel:reason:Container', container_reason - A short (255 max characters) human-readable string to provide additional
details about a running or stopped container.
$sel:lastStatus:Container', container_lastStatus - The last known status of the container.
$sel:cpu:Container', container_cpu - The number of CPU units set for the container. The value will be 0 if
no value was specified in the container definition when the task
definition was registered.
$sel:networkInterfaces:Container', container_networkInterfaces - The network interfaces associated with the container.
$sel:healthStatus:Container', container_healthStatus - The health status of the container. If health checks are not configured
for this container in its task definition, then it reports the health
status as UNKNOWN.
$sel:taskArn:Container', container_taskArn - The ARN of the task.
container_imageDigest :: Lens' Container (Maybe Text) Source #
The container image manifest digest.
The imageDigest is only returned if the container is using an image
hosted in Amazon ECR, otherwise it is omitted.
container_gpuIds :: Lens' Container (Maybe [Text]) Source #
The IDs of each GPU assigned to the container.
container_memoryReservation :: Lens' Container (Maybe Text) Source #
The soft limit (in MiB) of memory set for the container.
container_memory :: Lens' Container (Maybe Text) Source #
The hard limit (in MiB) of memory set for the container.
container_exitCode :: Lens' Container (Maybe Int) Source #
The exit code returned from the container.
container_containerArn :: Lens' Container (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container.
container_managedAgents :: Lens' Container (Maybe [ManagedAgent]) Source #
The details of any Amazon ECS managed agents associated with the container.
container_networkBindings :: Lens' Container (Maybe [NetworkBinding]) Source #
The network bindings associated with the container.
container_reason :: Lens' Container (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
container_lastStatus :: Lens' Container (Maybe Text) Source #
The last known status of the container.
container_cpu :: Lens' Container (Maybe Text) Source #
The number of CPU units set for the container. The value will be 0 if
no value was specified in the container definition when the task
definition was registered.
container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface]) Source #
The network interfaces associated with the container.
container_healthStatus :: Lens' Container (Maybe HealthStatus) Source #
The health status of the container. If health checks are not configured
for this container in its task definition, then it reports the health
status as UNKNOWN.
ContainerDefinition
data ContainerDefinition Source #
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
See: newContainerDefinition smart constructor.
Constructors
| ContainerDefinition' | |
Fields
| |
Instances
newContainerDefinition :: ContainerDefinition Source #
Create a value of ContainerDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostname:ContainerDefinition', containerDefinition_hostname - The hostname to use for your container. This parameter maps to
Hostname in the
Create a container
section of the
Docker Remote API and the
--hostname option to
docker run.
The hostname parameter is not supported if you are using the awsvpc
network mode.
$sel:linuxParameters:ContainerDefinition', containerDefinition_linuxParameters - Linux-specific modifications that are applied to the container, such as
Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
$sel:firelensConfiguration:ContainerDefinition', containerDefinition_firelensConfiguration - The FireLens configuration for the container. This is used to specify
and configure a log router for container logs. For more information, see
Custom Log Routing
in the Amazon Elastic Container Service Developer Guide.
$sel:dependsOn:ContainerDefinition', containerDefinition_dependsOn - The dependencies defined for container startup and shutdown. A container
can contain multiple dependencies. When a dependency is defined for
container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at
least version 1.26.0 of the container agent to enable container
dependencies. However, we recommend using the latest container agent
version. For information about checking your agent version and updating
to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you are
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires
platform version 1.3.0 or later.
$sel:memoryReservation:ContainerDefinition', containerDefinition_memoryReservation - The soft limit (in MiB) of memory to reserve for the container. When
system memory is under heavy contention, Docker attempts to keep the
container memory to this soft limit. However, your container can consume
more memory when it needs to, up to either the hard limit specified with
the memory parameter (if applicable), or all of the available memory
on the container instance, whichever comes first. This parameter maps to
MemoryReservation in the
Create a container
section of the
Docker Remote API and the
--memory-reservation option to
docker run.
If a task-level memory value is not specified, you must specify a
non-zero integer for one or both of memory or memoryReservation in a
container definition. If you specify both, memory must be greater than
memoryReservation. If you specify memoryReservation, then that value
is subtracted from the available memory resources for the container
instance on which the container is placed. Otherwise, the value of
memory is used.
For example, if your container normally uses 128 MiB of memory, but
occasionally bursts to 256 MiB of memory for short periods of time, you
can set a memoryReservation of 128 MiB, and a memory hard limit of
300 MiB. This configuration would allow the container to only reserve
128 MiB of memory from the remaining resources on the container
instance, but also allow the container to consume more memory resources
when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
$sel:dockerLabels:ContainerDefinition', containerDefinition_dockerLabels - A key/value map of labels to add to the container. This parameter maps
to Labels in the
Create a container
section of the
Docker Remote API and the
--label option to
docker run.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
$sel:memory:ContainerDefinition', containerDefinition_memory - The amount (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is
killed. The total amount of memory reserved for all containers within a
task must be lower than the task memory value, if one is specified.
This parameter maps to Memory in the
Create a container
section of the
Docker Remote API and the
--memory option to
docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level
memory value or a container-level memory value. If you specify both a
container-level memory and memoryReservation value, memory must be
greater than memoryReservation. If you specify memoryReservation,
then that value is subtracted from the available memory resources for
the container instance on which the container is placed. Otherwise, the
value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
$sel:extraHosts:ContainerDefinition', containerDefinition_extraHosts - A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. This parameter maps to
ExtraHosts in the
Create a container
section of the
Docker Remote API and the
--add-host option to
docker run.
This parameter is not supported for Windows containers or tasks that use
the awsvpc network mode.
$sel:user:ContainerDefinition', containerDefinition_user - The user to use inside the container. This parameter maps to User in
the
Create a container
section of the
Docker Remote API and the
--user option to
docker run.
When running tasks using the host network mode, you should not run
containers using the root user (UID 0). It is considered best practice
to use a non-root user.
You can specify the user using the following formats. If specifying a
UID or GID, you must specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
$sel:systemControls:ContainerDefinition', containerDefinition_systemControls - A list of namespaced kernel parameters to set in the container. This
parameter maps to Sysctls in the
Create a container
section of the
Docker Remote API and the
--sysctl option to
docker run.
It is not recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses
either the awsvpc or host network modes. For tasks that use the
awsvpc network mode, the container that is started last determines
which systemControls parameters take effect. For tasks that use the
host network mode, it changes the container instance's namespaced
kernel parameters as well as the containers.
$sel:privileged:ContainerDefinition', containerDefinition_privileged - When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root user). This
parameter maps to Privileged in the
Create a container
section of the
Docker Remote API and the
--privileged option to
docker run.
This parameter is not supported for Windows containers or tasks run on Fargate.
$sel:links:ContainerDefinition', containerDefinition_links - The links parameter allows containers to communicate with each other
without the need for port mappings. This parameter is only supported if
the network mode of a task definition is bridge. The
name:internalName construct is analogous to name:alias in Docker
links. Up to 255 letters (uppercase and lowercase), numbers,
underscores, and hyphens are allowed. For more information about linking
Docker containers, go to
Legacy container links in the
Docker documentation. This parameter maps to Links in the
Create a container
section of the
Docker Remote API and the
--link option to
docker run.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
$sel:interactive:ContainerDefinition', containerDefinition_interactive - When this parameter is true, this allows you to deploy containerized
applications that require stdin or a tty to be allocated. This
parameter maps to OpenStdin in the
Create a container
section of the
Docker Remote API and the
--interactive option to
docker run.
$sel:environmentFiles:ContainerDefinition', containerDefinition_environmentFiles - A list of files containing the environment variables to pass to a
container. This parameter maps to the --env-file option to
docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each line in an environment file should contain an
environment variable in VARIABLE=VALUE format. Lines beginning with
# are treated as comments and are ignored. For more information on the
environment variable file syntax, see
Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition, they take precedence over the
variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they are processed
from the top down. It is recommended to use unique variable names. For
more information, see
Specifying Environment Variables
in the Amazon Elastic Container Service Developer Guide.
$sel:entryPoint:ContainerDefinition', containerDefinition_entryPoint - Early versions of the Amazon ECS container agent do not properly handle
entryPoint parameters. If you have problems using entryPoint, update
your container agent or enter your commands and arguments as command
array items instead.
The entry point that is passed to the container. This parameter maps to
Entrypoint in the
Create a container
section of the
Docker Remote API and the
--entrypoint option to
docker run.
For more information, see
https://docs.docker.com/engine/reference/builder/#entrypoint.
$sel:workingDirectory:ContainerDefinition', containerDefinition_workingDirectory - The working directory in which to run commands inside the container.
This parameter maps to WorkingDir in the
Create a container
section of the
Docker Remote API and the
--workdir option to
docker run.
$sel:environment:ContainerDefinition', containerDefinition_environment - The environment variables to pass to a container. This parameter maps to
Env in the
Create a container
section of the
Docker Remote API and the
--env option to
docker run.
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
$sel:secrets:ContainerDefinition', containerDefinition_secrets - The secrets to pass to the container. For more information, see
Specifying Sensitive Data
in the Amazon Elastic Container Service Developer Guide.
$sel:volumesFrom:ContainerDefinition', containerDefinition_volumesFrom - Data volumes to mount from another container. This parameter maps to
VolumesFrom in the
Create a container
section of the
Docker Remote API and the
--volumes-from option to
docker run.
$sel:mountPoints:ContainerDefinition', containerDefinition_mountPoints - The mount points for data volumes in your container.
This parameter maps to Volumes in the
Create a container
section of the
Docker Remote API and the
--volume option to
docker run.
Windows containers can mount whole directories on the same drive as
$env:ProgramData. Windows containers cannot mount directories on a
different drive, and mount point cannot be across drives.
$sel:command:ContainerDefinition', containerDefinition_command - The command that is passed to the container. This parameter maps to
Cmd in the
Create a container
section of the
Docker Remote API and the
COMMAND parameter to
docker run.
For more information, see
https://docs.docker.com/engine/reference/builder/#cmd. If there are
multiple arguments, each argument should be a separated string in the
array.
$sel:dnsServers:ContainerDefinition', containerDefinition_dnsServers - A list of DNS servers that are presented to the container. This
parameter maps to Dns in the
Create a container
section of the
Docker Remote API and the
--dns option to
docker run.
This parameter is not supported for Windows containers.
$sel:name:ContainerDefinition', containerDefinition_name - The name of a container. If you are linking multiple containers together
in a task definition, the name of one container can be entered in the
links of another container to connect the containers. Up to 255
letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. This parameter maps to name in the
Create a container
section of the
Docker Remote API and the
--name option to
docker run.
$sel:image:ContainerDefinition', containerDefinition_image - The image used to start a container. This string is passed directly to
the Docker daemon. Images in the Docker Hub registry are available by
default. Other repositories are specified with either
repository-url/image:tag or repository-url/image@digest . Up
to 255 letters (uppercase and lowercase), numbers, hyphens, underscores,
colons, periods, forward slashes, and number signs are allowed. This
parameter maps to Image in the
Create a container
section of the
Docker Remote API and the
IMAGE parameter of
docker run.
- When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.
- Images in Amazon ECR repositories can be specified by either using
the full
registry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. - Images in official repositories on Docker Hub use a single name (for
example,
ubuntuormongo). - Images in other repositories on Docker Hub are qualified with an
organization name (for example,
amazon/amazon-ecs-agent). - Images in other online repositories are qualified further by a
domain name (for example,
quay.io/assemblyline/ubuntu).
$sel:dnsSearchDomains:ContainerDefinition', containerDefinition_dnsSearchDomains - A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch in the
Create a container
section of the
Docker Remote API and the
--dns-search option to
docker run.
This parameter is not supported for Windows containers.
$sel:pseudoTerminal:ContainerDefinition', containerDefinition_pseudoTerminal - When this parameter is true, a TTY is allocated. This parameter maps
to Tty in the
Create a container
section of the
Docker Remote API and the
--tty option to
docker run.
$sel:logConfiguration:ContainerDefinition', containerDefinition_logConfiguration - The log configuration specification for the container.
This parameter maps to LogConfig in the
Create a container
section of the
Docker Remote API and the
--log-driver option to
docker run.
By default, containers use the same logging driver that the Docker
daemon uses. However the container may use a different logging driver
than the Docker daemon by specifying a log driver with this parameter in
the container definition. To use a different logging driver for a
container, the log system must be configured properly on the container
instance (or on a different log server for remote logging options). For
more information on the options for different supported log drivers, see
Configure logging drivers
in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
$sel:portMappings:ContainerDefinition', containerDefinition_portMappings - The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send or
receive traffic.
For task definitions that use the awsvpc network mode, you should only
specify the containerPort. The hostPort can be left blank or it must
be the same value as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than
localhost. There is no loopback for port mappings on Windows, so you
cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings in the
Create a container
section of the
Docker Remote API and the
--publish option to
docker run.
If the network mode of a task definition is set to none, then you
can't specify port mappings. If the network mode of a task definition
is set to host, then host ports must either be undefined or they must
match the container port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host and
container port assignments are visible in the Network Bindings
section of a container description for a selected task in the Amazon ECS
console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
$sel:essential:ContainerDefinition', containerDefinition_essential - If the essential parameter of a container is marked as true, and
that container fails or stops for any reason, all other containers that
are part of the task are stopped. If the essential parameter of a
container is marked as false, then its failure does not affect the
rest of the containers in a task. If this parameter is omitted, a
container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
$sel:cpu:ContainerDefinition', containerDefinition_cpu - The number of cpu units reserved for the container. This parameter
maps to CpuShares in the
Create a container
section of the
Docker Remote API and the
--cpu-shares option to
docker run.
This field is optional for tasks using the Fargate launch type, and the
only requirement is that the total amount of CPU reserved for all
containers within a task be lower than the task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
- Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
- Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
On Windows container instances, the CPU limit is enforced as an absolute
limit, or a quota. Windows containers only have access to the specified
amount of CPU that is described in the task definition. A null or zero
CPU value is passed to Docker as 0, which Windows interprets as 1% of
one CPU.
$sel:resourceRequirements:ContainerDefinition', containerDefinition_resourceRequirements - The type and amount of a resource to assign to a container. The only
supported resource is a GPU.
$sel:ulimits:ContainerDefinition', containerDefinition_ulimits - A list of ulimits to set in the container. If a ulimit value is
specified in a task definition, it will override the default values set
by Docker. This parameter maps to Ulimits in the
Create a container
section of the
Docker Remote API and the
--ulimit option to
docker run.
Valid naming values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values
set by the operating system with the exception of the nofile resource
limit parameter which Fargate overrides. The nofile resource limit
sets a restriction on the number of open files that a container can use.
The default nofile soft limit is 1024 and hard limit is 4096.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
$sel:startTimeout:ContainerDefinition', containerDefinition_startTimeout - Time duration (in seconds) to wait before giving up on resolving
dependencies for a container. For example, you specify two containers in
a task definition with containerA having a dependency on containerB
reaching a COMPLETE, SUCCESS, or HEALTHY status. If a
startTimeout value is specified for containerB and it does not reach
the desired status within that time then containerA will give up and not
start. This results in the task transitioning to a STOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration
variable is used, it is enforced indendently from this start timeout
value.
For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
For tasks using the EC2 launch type, your container instances require at
least version 1.26.0 of the container agent to enable a container
start timeout value. However, we recommend using the latest container
agent version. For information about checking your agent version and
updating to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you are
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container
instances are launched from version 20190301 or later, then they
contain the required versions of the container agent and ecs-init. For
more information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
$sel:readonlyRootFilesystem:ContainerDefinition', containerDefinition_readonlyRootFilesystem - When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs in the
Create a container
section of the
Docker Remote API and the
--read-only option to
docker run.
This parameter is not supported for Windows containers.
$sel:stopTimeout:ContainerDefinition', containerDefinition_stopTimeout - Time duration (in seconds) to wait before the container is forcefully
killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks using the EC2 launch type, if the stopTimeout parameter is
not specified, the value set for the Amazon ECS container agent
configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default.
If neither the stopTimeout parameter or the
ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then
the default values of 30 seconds for Linux containers and 30 seconds on
Windows containers are used. Your container instances require at least
version 1.26.0 of the container agent to enable a container stop timeout
value. However, we recommend using the latest container agent version.
For information about checking your agent version and updating to the
latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you are
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
$sel:healthCheck:ContainerDefinition', containerDefinition_healthCheck - The container health check command and associated configuration
parameters for the container. This parameter maps to HealthCheck in
the
Create a container
section of the
Docker Remote API and the
HEALTHCHECK parameter of
docker run.
$sel:dockerSecurityOptions:ContainerDefinition', containerDefinition_dockerSecurityOptions - A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems. This field is not valid for containers in
tasks using the Fargate launch type.
With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt in the
Create a container
section of the
Docker Remote API and the
--security-opt option to
docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true or
ECS_APPARMOR_CAPABLE=true environment variables before containers
placed on that instance can use these security options. For more
information, see
Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
$sel:disableNetworking:ContainerDefinition', containerDefinition_disableNetworking - When this parameter is true, networking is disabled within the
container. This parameter maps to NetworkDisabled in the
Create a container
section of the
Docker Remote API.
This parameter is not supported for Windows containers.
$sel:repositoryCredentials:ContainerDefinition', containerDefinition_repositoryCredentials - The private repository authentication credentials to use.
containerDefinition_hostname :: Lens' ContainerDefinition (Maybe Text) Source #
The hostname to use for your container. This parameter maps to
Hostname in the
Create a container
section of the
Docker Remote API and the
--hostname option to
docker run.
The hostname parameter is not supported if you are using the awsvpc
network mode.
containerDefinition_linuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
containerDefinition_firelensConfiguration :: Lens' ContainerDefinition (Maybe FirelensConfiguration) Source #
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
containerDefinition_dependsOn :: Lens' ContainerDefinition (Maybe [ContainerDependency]) Source #
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at
least version 1.26.0 of the container agent to enable container
dependencies. However, we recommend using the latest container agent
version. For information about checking your agent version and updating
to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you are
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires
platform version 1.3.0 or later.
containerDefinition_memoryReservation :: Lens' ContainerDefinition (Maybe Int) Source #
The soft limit (in MiB) of memory to reserve for the container. When
system memory is under heavy contention, Docker attempts to keep the
container memory to this soft limit. However, your container can consume
more memory when it needs to, up to either the hard limit specified with
the memory parameter (if applicable), or all of the available memory
on the container instance, whichever comes first. This parameter maps to
MemoryReservation in the
Create a container
section of the
Docker Remote API and the
--memory-reservation option to
docker run.
If a task-level memory value is not specified, you must specify a
non-zero integer for one or both of memory or memoryReservation in a
container definition. If you specify both, memory must be greater than
memoryReservation. If you specify memoryReservation, then that value
is subtracted from the available memory resources for the container
instance on which the container is placed. Otherwise, the value of
memory is used.
For example, if your container normally uses 128 MiB of memory, but
occasionally bursts to 256 MiB of memory for short periods of time, you
can set a memoryReservation of 128 MiB, and a memory hard limit of
300 MiB. This configuration would allow the container to only reserve
128 MiB of memory from the remaining resources on the container
instance, but also allow the container to consume more memory resources
when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
containerDefinition_dockerLabels :: Lens' ContainerDefinition (Maybe (HashMap Text Text)) Source #
A key/value map of labels to add to the container. This parameter maps
to Labels in the
Create a container
section of the
Docker Remote API and the
--label option to
docker run.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
containerDefinition_memory :: Lens' ContainerDefinition (Maybe Int) Source #
The amount (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is
killed. The total amount of memory reserved for all containers within a
task must be lower than the task memory value, if one is specified.
This parameter maps to Memory in the
Create a container
section of the
Docker Remote API and the
--memory option to
docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level
memory value or a container-level memory value. If you specify both a
container-level memory and memoryReservation value, memory must be
greater than memoryReservation. If you specify memoryReservation,
then that value is subtracted from the available memory resources for
the container instance on which the container is placed. Otherwise, the
value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
containerDefinition_extraHosts :: Lens' ContainerDefinition (Maybe [HostEntry]) Source #
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. This parameter maps to
ExtraHosts in the
Create a container
section of the
Docker Remote API and the
--add-host option to
docker run.
This parameter is not supported for Windows containers or tasks that use
the awsvpc network mode.
containerDefinition_user :: Lens' ContainerDefinition (Maybe Text) Source #
The user to use inside the container. This parameter maps to User in
the
Create a container
section of the
Docker Remote API and the
--user option to
docker run.
When running tasks using the host network mode, you should not run
containers using the root user (UID 0). It is considered best practice
to use a non-root user.
You can specify the user using the following formats. If specifying a
UID or GID, you must specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
containerDefinition_systemControls :: Lens' ContainerDefinition (Maybe [SystemControl]) Source #
A list of namespaced kernel parameters to set in the container. This
parameter maps to Sysctls in the
Create a container
section of the
Docker Remote API and the
--sysctl option to
docker run.
It is not recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses
either the awsvpc or host network modes. For tasks that use the
awsvpc network mode, the container that is started last determines
which systemControls parameters take effect. For tasks that use the
host network mode, it changes the container instance's namespaced
kernel parameters as well as the containers.
containerDefinition_privileged :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root user). This
parameter maps to Privileged in the
Create a container
section of the
Docker Remote API and the
--privileged option to
docker run.
This parameter is not supported for Windows containers or tasks run on Fargate.
containerDefinition_links :: Lens' ContainerDefinition (Maybe [Text]) Source #
The links parameter allows containers to communicate with each other
without the need for port mappings. This parameter is only supported if
the network mode of a task definition is bridge. The
name:internalName construct is analogous to name:alias in Docker
links. Up to 255 letters (uppercase and lowercase), numbers,
underscores, and hyphens are allowed. For more information about linking
Docker containers, go to
Legacy container links in the
Docker documentation. This parameter maps to Links in the
Create a container
section of the
Docker Remote API and the
--link option to
docker run.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
containerDefinition_interactive :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, this allows you to deploy containerized
applications that require stdin or a tty to be allocated. This
parameter maps to OpenStdin in the
Create a container
section of the
Docker Remote API and the
--interactive option to
docker run.
containerDefinition_environmentFiles :: Lens' ContainerDefinition (Maybe [EnvironmentFile]) Source #
A list of files containing the environment variables to pass to a
container. This parameter maps to the --env-file option to
docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each line in an environment file should contain an
environment variable in VARIABLE=VALUE format. Lines beginning with
# are treated as comments and are ignored. For more information on the
environment variable file syntax, see
Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition, they take precedence over the
variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they are processed
from the top down. It is recommended to use unique variable names. For
more information, see
Specifying Environment Variables
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_entryPoint :: Lens' ContainerDefinition (Maybe [Text]) Source #
Early versions of the Amazon ECS container agent do not properly handle
entryPoint parameters. If you have problems using entryPoint, update
your container agent or enter your commands and arguments as command
array items instead.
The entry point that is passed to the container. This parameter maps to
Entrypoint in the
Create a container
section of the
Docker Remote API and the
--entrypoint option to
docker run.
For more information, see
https://docs.docker.com/engine/reference/builder/#entrypoint.
containerDefinition_workingDirectory :: Lens' ContainerDefinition (Maybe Text) Source #
The working directory in which to run commands inside the container.
This parameter maps to WorkingDir in the
Create a container
section of the
Docker Remote API and the
--workdir option to
docker run.
containerDefinition_environment :: Lens' ContainerDefinition (Maybe [KeyValuePair]) Source #
The environment variables to pass to a container. This parameter maps to
Env in the
Create a container
section of the
Docker Remote API and the
--env option to
docker run.
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
containerDefinition_secrets :: Lens' ContainerDefinition (Maybe [Secret]) Source #
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
containerDefinition_volumesFrom :: Lens' ContainerDefinition (Maybe [VolumeFrom]) Source #
Data volumes to mount from another container. This parameter maps to
VolumesFrom in the
Create a container
section of the
Docker Remote API and the
--volumes-from option to
docker run.
containerDefinition_mountPoints :: Lens' ContainerDefinition (Maybe [MountPoint]) Source #
The mount points for data volumes in your container.
This parameter maps to Volumes in the
Create a container
section of the
Docker Remote API and the
--volume option to
docker run.
Windows containers can mount whole directories on the same drive as
$env:ProgramData. Windows containers cannot mount directories on a
different drive, and mount point cannot be across drives.
containerDefinition_command :: Lens' ContainerDefinition (Maybe [Text]) Source #
The command that is passed to the container. This parameter maps to
Cmd in the
Create a container
section of the
Docker Remote API and the
COMMAND parameter to
docker run.
For more information, see
https://docs.docker.com/engine/reference/builder/#cmd. If there are
multiple arguments, each argument should be a separated string in the
array.
containerDefinition_dnsServers :: Lens' ContainerDefinition (Maybe [Text]) Source #
A list of DNS servers that are presented to the container. This
parameter maps to Dns in the
Create a container
section of the
Docker Remote API and the
--dns option to
docker run.
This parameter is not supported for Windows containers.
containerDefinition_name :: Lens' ContainerDefinition (Maybe Text) Source #
The name of a container. If you are linking multiple containers together
in a task definition, the name of one container can be entered in the
links of another container to connect the containers. Up to 255
letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. This parameter maps to name in the
Create a container
section of the
Docker Remote API and the
--name option to
docker run.
containerDefinition_image :: Lens' ContainerDefinition (Maybe Text) Source #
The image used to start a container. This string is passed directly to
the Docker daemon. Images in the Docker Hub registry are available by
default. Other repositories are specified with either
repository-url/image:tag or repository-url/image@digest . Up
to 255 letters (uppercase and lowercase), numbers, hyphens, underscores,
colons, periods, forward slashes, and number signs are allowed. This
parameter maps to Image in the
Create a container
section of the
Docker Remote API and the
IMAGE parameter of
docker run.
- When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.
- Images in Amazon ECR repositories can be specified by either using
the full
registry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. - Images in official repositories on Docker Hub use a single name (for
example,
ubuntuormongo). - Images in other repositories on Docker Hub are qualified with an
organization name (for example,
amazon/amazon-ecs-agent). - Images in other online repositories are qualified further by a
domain name (for example,
quay.io/assemblyline/ubuntu).
containerDefinition_dnsSearchDomains :: Lens' ContainerDefinition (Maybe [Text]) Source #
A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch in the
Create a container
section of the
Docker Remote API and the
--dns-search option to
docker run.
This parameter is not supported for Windows containers.
containerDefinition_pseudoTerminal :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, a TTY is allocated. This parameter maps
to Tty in the
Create a container
section of the
Docker Remote API and the
--tty option to
docker run.
containerDefinition_logConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration) Source #
The log configuration specification for the container.
This parameter maps to LogConfig in the
Create a container
section of the
Docker Remote API and the
--log-driver option to
docker run.
By default, containers use the same logging driver that the Docker
daemon uses. However the container may use a different logging driver
than the Docker daemon by specifying a log driver with this parameter in
the container definition. To use a different logging driver for a
container, the log system must be configured properly on the container
instance (or on a different log server for remote logging options). For
more information on the options for different supported log drivers, see
Configure logging drivers
in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_portMappings :: Lens' ContainerDefinition (Maybe [PortMapping]) Source #
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, you should only
specify the containerPort. The hostPort can be left blank or it must
be the same value as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than
localhost. There is no loopback for port mappings on Windows, so you
cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings in the
Create a container
section of the
Docker Remote API and the
--publish option to
docker run.
If the network mode of a task definition is set to none, then you
can't specify port mappings. If the network mode of a task definition
is set to host, then host ports must either be undefined or they must
match the container port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host and
container port assignments are visible in the Network Bindings
section of a container description for a selected task in the Amazon ECS
console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
containerDefinition_essential :: Lens' ContainerDefinition (Maybe Bool) Source #
If the essential parameter of a container is marked as true, and
that container fails or stops for any reason, all other containers that
are part of the task are stopped. If the essential parameter of a
container is marked as false, then its failure does not affect the
rest of the containers in a task. If this parameter is omitted, a
container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
containerDefinition_cpu :: Lens' ContainerDefinition (Maybe Int) Source #
The number of cpu units reserved for the container. This parameter
maps to CpuShares in the
Create a container
section of the
Docker Remote API and the
--cpu-shares option to
docker run.
This field is optional for tasks using the Fargate launch type, and the
only requirement is that the total amount of CPU reserved for all
containers within a task be lower than the task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
- Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
- Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
On Windows container instances, the CPU limit is enforced as an absolute
limit, or a quota. Windows containers only have access to the specified
amount of CPU that is described in the task definition. A null or zero
CPU value is passed to Docker as 0, which Windows interprets as 1% of
one CPU.
containerDefinition_resourceRequirements :: Lens' ContainerDefinition (Maybe [ResourceRequirement]) Source #
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
containerDefinition_ulimits :: Lens' ContainerDefinition (Maybe [Ulimit]) Source #
A list of ulimits to set in the container. If a ulimit value is
specified in a task definition, it will override the default values set
by Docker. This parameter maps to Ulimits in the
Create a container
section of the
Docker Remote API and the
--ulimit option to
docker run.
Valid naming values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values
set by the operating system with the exception of the nofile resource
limit parameter which Fargate overrides. The nofile resource limit
sets a restriction on the number of open files that a container can use.
The default nofile soft limit is 1024 and hard limit is 4096.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
containerDefinition_startTimeout :: Lens' ContainerDefinition (Maybe Int) Source #
Time duration (in seconds) to wait before giving up on resolving
dependencies for a container. For example, you specify two containers in
a task definition with containerA having a dependency on containerB
reaching a COMPLETE, SUCCESS, or HEALTHY status. If a
startTimeout value is specified for containerB and it does not reach
the desired status within that time then containerA will give up and not
start. This results in the task transitioning to a STOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration
variable is used, it is enforced indendently from this start timeout
value.
For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
For tasks using the EC2 launch type, your container instances require at
least version 1.26.0 of the container agent to enable a container
start timeout value. However, we recommend using the latest container
agent version. For information about checking your agent version and
updating to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you are
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container
instances are launched from version 20190301 or later, then they
contain the required versions of the container agent and ecs-init. For
more information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_readonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs in the
Create a container
section of the
Docker Remote API and the
--read-only option to
docker run.
This parameter is not supported for Windows containers.
containerDefinition_stopTimeout :: Lens' ContainerDefinition (Maybe Int) Source #
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks using the EC2 launch type, if the stopTimeout parameter is
not specified, the value set for the Amazon ECS container agent
configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default.
If neither the stopTimeout parameter or the
ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then
the default values of 30 seconds for Linux containers and 30 seconds on
Windows containers are used. Your container instances require at least
version 1.26.0 of the container agent to enable a container stop timeout
value. However, we recommend using the latest container agent version.
For information about checking your agent version and updating to the
latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you are
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_healthCheck :: Lens' ContainerDefinition (Maybe HealthCheck) Source #
The container health check command and associated configuration
parameters for the container. This parameter maps to HealthCheck in
the
Create a container
section of the
Docker Remote API and the
HEALTHCHECK parameter of
docker run.
containerDefinition_dockerSecurityOptions :: Lens' ContainerDefinition (Maybe [Text]) Source #
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt in the
Create a container
section of the
Docker Remote API and the
--security-opt option to
docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true or
ECS_APPARMOR_CAPABLE=true environment variables before containers
placed on that instance can use these security options. For more
information, see
Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
containerDefinition_disableNetworking :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, networking is disabled within the
container. This parameter maps to NetworkDisabled in the
Create a container
section of the
Docker Remote API.
This parameter is not supported for Windows containers.
containerDefinition_repositoryCredentials :: Lens' ContainerDefinition (Maybe RepositoryCredentials) Source #
The private repository authentication credentials to use.
ContainerDependency
data ContainerDependency Source #
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
Your Amazon ECS container instances require at least version 1.26.0 of
the container agent to enable container dependencies. However, we
recommend using the latest container agent version. For information
about checking your agent version and updating to the latest version,
see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you are
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
See: newContainerDependency smart constructor.
Constructors
| ContainerDependency' | |
Fields
| |
Instances
newContainerDependency Source #
Arguments
| :: Text | |
| -> ContainerCondition | |
| -> ContainerDependency |
Create a value of ContainerDependency with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerName:ContainerDependency', containerDependency_containerName - The name of a container.
$sel:condition:ContainerDependency', containerDependency_condition - The dependency condition of the container. The following are the
available conditions and their behavior:
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition cannot be set on an essential container.SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition cannot be set on an essential container.HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
containerDependency_containerName :: Lens' ContainerDependency Text Source #
The name of a container.
containerDependency_condition :: Lens' ContainerDependency ContainerCondition Source #
The dependency condition of the container. The following are the available conditions and their behavior:
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition cannot be set on an essential container.SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition cannot be set on an essential container.HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
ContainerInstance
data ContainerInstance Source #
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
See: newContainerInstance smart constructor.
Constructors
| ContainerInstance' | |
Fields
| |
Instances
newContainerInstance :: ContainerInstance Source #
Create a value of ContainerInstance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentUpdateStatus:ContainerInstance', containerInstance_agentUpdateStatus - The status of the most recent agent update. If an update has never been
requested, this value is NULL.
$sel:versionInfo:ContainerInstance', containerInstance_versionInfo - The version information for the Amazon ECS container agent and Docker
daemon running on the container instance.
$sel:status:ContainerInstance', containerInstance_status - The status of the container instance. The valid values are
REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE,
DEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting,
then any newly registered container instance will transition to a
REGISTERING status while the trunk elastic network interface is
provisioned for the instance. If the registration fails, the instance
will transition to a REGISTRATION_FAILED status. You can describe the
container instance and see the reason for failure in the statusReason
parameter. Once the container instance is terminated, the instance
transitions to a DEREGISTERING status while the trunk elastic network
interface is deprovisioned. The instance then transitions to an
INACTIVE status.
The ACTIVE status indicates that the container instance can accept
tasks. The DRAINING indicates that new tasks are not placed on the
container instance and any service tasks running on the container
instance are removed if possible. For more information, see
Container Instance Draining
in the Amazon Elastic Container Service Developer Guide.
$sel:registeredResources:ContainerInstance', containerInstance_registeredResources - For CPU and memory resource types, this parameter describes the amount
of each resource that was available on the container instance when the
container agent registered it with Amazon ECS. This value represents the
total amount of CPU and memory that can be allocated on this container
instance to tasks. For port resource types, this parameter describes the
ports that were reserved by the Amazon ECS container agent when it
registered the container instance with Amazon ECS.
$sel:containerInstanceArn:ContainerInstance', containerInstance_containerInstanceArn - The Amazon Resource Name (ARN) of the container instance. The ARN
contains the arn:aws:ecs namespace, followed by the Region of the
container instance, the Amazon Web Services account ID of the container
instance owner, the container-instance namespace, and then the
container instance ID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
$sel:registeredAt:ContainerInstance', containerInstance_registeredAt - The Unix timestamp for when the container instance was registered.
$sel:pendingTasksCount:ContainerInstance', containerInstance_pendingTasksCount - The number of tasks on the container instance that are in the PENDING
status.
$sel:version:ContainerInstance', containerInstance_version - The version counter for the container instance. Every time a container
instance experiences a change that triggers a CloudWatch event, the
version counter is incremented. If you are replicating your Amazon ECS
container instance state with CloudWatch Events, you can compare the
version of a container instance reported by the Amazon ECS APIs with the
version reported in CloudWatch Events for the container instance (inside
the detail object) to verify that the version in your event stream is
current.
$sel:attributes:ContainerInstance', containerInstance_attributes - The attributes set for the container instance, either by the Amazon ECS
container agent at instance registration or manually with the
PutAttributes operation.
$sel:tags:ContainerInstance', containerInstance_tags - The metadata that you apply to the container instance to help you
categorize and organize them. Each tag consists of a key and an optional
value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
$sel:agentConnected:ContainerInstance', containerInstance_agentConnected - This parameter returns true if the agent is connected to Amazon ECS.
Registered instances with an agent that may be unhealthy or stopped
return false. Only instances connected to an agent can accept
placement requests.
$sel:ec2InstanceId:ContainerInstance', containerInstance_ec2InstanceId - The ID of the container instance. For Amazon EC2 instances, this value
is the Amazon EC2 instance ID. For external instances, this value is the
Amazon Web Services Systems Manager managed instance ID.
$sel:statusReason:ContainerInstance', containerInstance_statusReason - The reason that the container instance reached its current status.
$sel:remainingResources:ContainerInstance', containerInstance_remainingResources - For CPU and memory resource types, this parameter describes the
remaining CPU and memory that has not already been allocated to tasks
and is therefore available for new tasks. For port resource types, this
parameter describes the ports that were reserved by the Amazon ECS
container agent (at instance registration time) and any task containers
that have reserved port mappings on the host (with the host or
bridge network mode). Any port that is not specified here is available
for new tasks.
$sel:runningTasksCount:ContainerInstance', containerInstance_runningTasksCount - The number of tasks on the container instance that are in the RUNNING
status.
$sel:capacityProviderName:ContainerInstance', containerInstance_capacityProviderName - The capacity provider associated with the container instance.
$sel:attachments:ContainerInstance', containerInstance_attachments - The resources attached to a container instance, such as elastic network
interfaces.
containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus) Source #
The status of the most recent agent update. If an update has never been
requested, this value is NULL.
containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo) Source #
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
containerInstance_status :: Lens' ContainerInstance (Maybe Text) Source #
The status of the container instance. The valid values are
REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE,
DEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting,
then any newly registered container instance will transition to a
REGISTERING status while the trunk elastic network interface is
provisioned for the instance. If the registration fails, the instance
will transition to a REGISTRATION_FAILED status. You can describe the
container instance and see the reason for failure in the statusReason
parameter. Once the container instance is terminated, the instance
transitions to a DEREGISTERING status while the trunk elastic network
interface is deprovisioned. The instance then transitions to an
INACTIVE status.
The ACTIVE status indicates that the container instance can accept
tasks. The DRAINING indicates that new tasks are not placed on the
container instance and any service tasks running on the container
instance are removed if possible. For more information, see
Container Instance Draining
in the Amazon Elastic Container Service Developer Guide.
containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource]) Source #
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container instance. The ARN
contains the arn:aws:ecs namespace, followed by the Region of the
container instance, the Amazon Web Services account ID of the container
instance owner, the container-instance namespace, and then the
container instance ID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime) Source #
The Unix timestamp for when the container instance was registered.
containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the PENDING
status.
containerInstance_version :: Lens' ContainerInstance (Maybe Integer) Source #
The version counter for the container instance. Every time a container
instance experiences a change that triggers a CloudWatch event, the
version counter is incremented. If you are replicating your Amazon ECS
container instance state with CloudWatch Events, you can compare the
version of a container instance reported by the Amazon ECS APIs with the
version reported in CloudWatch Events for the container instance (inside
the detail object) to verify that the version in your event stream is
current.
containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute]) Source #
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag]) Source #
The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool) Source #
This parameter returns true if the agent is connected to Amazon ECS.
Registered instances with an agent that may be unhealthy or stopped
return false. Only instances connected to an agent can accept
placement requests.
containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text) Source #
The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text) Source #
The reason that the container instance reached its current status.
containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource]) Source #
For CPU and memory resource types, this parameter describes the
remaining CPU and memory that has not already been allocated to tasks
and is therefore available for new tasks. For port resource types, this
parameter describes the ports that were reserved by the Amazon ECS
container agent (at instance registration time) and any task containers
that have reserved port mappings on the host (with the host or
bridge network mode). Any port that is not specified here is available
for new tasks.
containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the RUNNING
status.
containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text) Source #
The capacity provider associated with the container instance.
containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment]) Source #
The resources attached to a container instance, such as elastic network interfaces.
ContainerOverride
data ContainerOverride Source #
The overrides that should be sent to a container. An empty container
override can be passed in. An example of an empty container override
would be {"containerOverrides": [ ] }. If a non-empty container
override is specified, the name parameter must be included.
See: newContainerOverride smart constructor.
Constructors
| ContainerOverride' | |
Fields
| |
Instances
newContainerOverride :: ContainerOverride Source #
Create a value of ContainerOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:memoryReservation:ContainerOverride', containerOverride_memoryReservation - The soft limit (in MiB) of memory to reserve for the container, instead
of the default value from the task definition. You must also specify a
container name.
$sel:memory:ContainerOverride', containerOverride_memory - The hard limit (in MiB) of memory to present to the container, instead
of the default value from the task definition. If your container
attempts to exceed the memory specified here, the container is killed.
You must also specify a container name.
$sel:environmentFiles:ContainerOverride', containerOverride_environmentFiles - A list of files containing the environment variables to pass to a
container, instead of the value from the container definition.
$sel:environment:ContainerOverride', containerOverride_environment - The environment variables to send to the container. You can add new
environment variables, which are added to the container at launch, or
you can override the existing environment variables from the Docker
image or the task definition. You must also specify a container name.
$sel:command:ContainerOverride', containerOverride_command - The command to send to the container that overrides the default command
from the Docker image or the task definition. You must also specify a
container name.
$sel:name:ContainerOverride', containerOverride_name - The name of the container that receives the override. This parameter is
required if any override is specified.
$sel:cpu:ContainerOverride', containerOverride_cpu - The number of cpu units reserved for the container, instead of the
default value from the task definition. You must also specify a
container name.
$sel:resourceRequirements:ContainerOverride', containerOverride_resourceRequirements - The type and amount of a resource to assign to a container, instead of
the default value from the task definition. The only supported resource
is a GPU.
containerOverride_memoryReservation :: Lens' ContainerOverride (Maybe Int) Source #
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
containerOverride_memory :: Lens' ContainerOverride (Maybe Int) Source #
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
containerOverride_environmentFiles :: Lens' ContainerOverride (Maybe [EnvironmentFile]) Source #
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
containerOverride_environment :: Lens' ContainerOverride (Maybe [KeyValuePair]) Source #
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
containerOverride_command :: Lens' ContainerOverride (Maybe [Text]) Source #
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
containerOverride_name :: Lens' ContainerOverride (Maybe Text) Source #
The name of the container that receives the override. This parameter is required if any override is specified.
containerOverride_cpu :: Lens' ContainerOverride (Maybe Int) Source #
The number of cpu units reserved for the container, instead of the
default value from the task definition. You must also specify a
container name.
containerOverride_resourceRequirements :: Lens' ContainerOverride (Maybe [ResourceRequirement]) Source #
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
ContainerService
data ContainerService Source #
Details on a service within a cluster
See: newContainerService smart constructor.
Constructors
| ContainerService' | |
Fields
| |
Instances
newContainerService :: ContainerService Source #
Create a value of ContainerService with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterArn:ContainerService', containerService_clusterArn - The Amazon Resource Name (ARN) of the cluster that hosts the service.
$sel:taskSets:ContainerService', containerService_taskSets - Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL deployment. An Amazon ECS task set includes details such
as the desired number of tasks, how many tasks are running, and whether
the task set serves production traffic.
$sel:runningCount:ContainerService', containerService_runningCount - The number of tasks in the cluster that are in the RUNNING state.
$sel:status:ContainerService', containerService_status - The status of the service. The valid values are ACTIVE, DRAINING, or
INACTIVE.
$sel:roleArn:ContainerService', containerService_roleArn - The ARN of the IAM role associated with the service that allows the
Amazon ECS container agent to register container instances with an
Elastic Load Balancing load balancer.
$sel:deploymentConfiguration:ContainerService', containerService_deploymentConfiguration - Optional deployment parameters that control how many tasks run during
the deployment and the ordering of stopping and starting tasks.
$sel:capacityProviderStrategy:ContainerService', containerService_capacityProviderStrategy - The capacity provider strategy the service is using. When using the
DescribeServices API, this field is omitted if the service was created
using a launch type.
$sel:networkConfiguration:ContainerService', containerService_networkConfiguration - The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
$sel:desiredCount:ContainerService', containerService_desiredCount - The desired number of instantiations of the task definition to keep
running on the service. This value is specified when the service is
created with CreateService, and it can be modified with UpdateService.
$sel:enableECSManagedTags:ContainerService', containerService_enableECSManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks in the
service. For more information, see
Tagging Your Amazon ECS Resources
in the Amazon Elastic Container Service Developer Guide.
$sel:deploymentController:ContainerService', containerService_deploymentController - The deployment controller type the service is using. When using the
DescribeServices API, this field is omitted if the service is using the
ECS deployment controller type.
$sel:launchType:ContainerService', containerService_launchType - The launch type the service is using. When using the DescribeServices
API, this field is omitted if the service was created using a capacity
provider strategy.
$sel:createdAt:ContainerService', containerService_createdAt - The Unix timestamp for when the service was created.
$sel:platformVersion:ContainerService', containerService_platformVersion - The platform version on which to run your service. A platform version is
only specified for tasks hosted on Fargate. If one is not specified, the
LATEST platform version is used by default. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$sel:deployments:ContainerService', containerService_deployments - The current state of deployments for the service.
$sel:placementStrategy:ContainerService', containerService_placementStrategy - The placement strategy that determines how tasks for the service are
placed.
$sel:serviceName:ContainerService', containerService_serviceName - The name of your service. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed. Service names must be
unique within a cluster, but you can have similarly named services in
multiple clusters within a Region or across multiple Regions.
$sel:placementConstraints:ContainerService', containerService_placementConstraints - The placement constraints for the tasks in the service.
$sel:events:ContainerService', containerService_events - The event stream for your service. A maximum of 100 of the latest events
are displayed.
$sel:pendingCount:ContainerService', containerService_pendingCount - The number of tasks in the cluster that are in the PENDING state.
$sel:enableExecuteCommand:ContainerService', containerService_enableExecuteCommand - Whether or not the execute command functionality is enabled for the
service. If true, the execute command functionality is enabled for all
containers in tasks as part of the service.
$sel:loadBalancers:ContainerService', containerService_loadBalancers - A list of Elastic Load Balancing load balancer objects, containing the
load balancer name, the container name (as it appears in a container
definition), and the container port to access from the load balancer.
$sel:tags:ContainerService', containerService_tags - The metadata that you apply to the service to help you categorize and
organize them. Each tag consists of a key and an optional value, both of
which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
$sel:healthCheckGracePeriodSeconds:ContainerService', containerService_healthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler
ignores unhealthy Elastic Load Balancing target health checks after a
task has first started.
$sel:serviceRegistries:ContainerService', containerService_serviceRegistries - The details of the service discovery registries to assign to this
service. For more information, see
Service Discovery.
$sel:createdBy:ContainerService', containerService_createdBy - The principal that created the service.
$sel:schedulingStrategy:ContainerService', containerService_schedulingStrategy - The scheduling strategy to use for the service. For more information,
see
Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.Fargate tasks do not support the
DAEMONscheduling strategy.
$sel:taskDefinition:ContainerService', containerService_taskDefinition - The task definition to use for tasks in the service. This value is
specified when the service is created with CreateService, and it can be
modified with UpdateService.
$sel:serviceArn:ContainerService', containerService_serviceArn - The ARN that identifies the service. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the service, the Amazon Web
Services account ID of the service owner, the service namespace, and
then the service name. For example,
arn:aws:ecs:region:012345678910:service/my-service.
$sel:propagateTags:ContainerService', containerService_propagateTags - Specifies whether to propagate the tags from the task definition or the
service to the task. If no value is specified, the tags are not
propagated.
containerService_clusterArn :: Lens' ContainerService (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster that hosts the service.
containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet]) Source #
Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL deployment. An Amazon ECS task set includes details such
as the desired number of tasks, how many tasks are running, and whether
the task set serves production traffic.
containerService_runningCount :: Lens' ContainerService (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING state.
containerService_status :: Lens' ContainerService (Maybe Text) Source #
The status of the service. The valid values are ACTIVE, DRAINING, or
INACTIVE.
containerService_roleArn :: Lens' ContainerService (Maybe Text) Source #
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration) Source #
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy the service is using. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration) Source #
The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
containerService_desiredCount :: Lens' ContainerService (Maybe Int) Source #
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool) Source #
Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController) Source #
The deployment controller type the service is using. When using the
DescribeServices API, this field is omitted if the service is using the
ECS deployment controller type.
containerService_launchType :: Lens' ContainerService (Maybe LaunchType) Source #
The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.
containerService_createdAt :: Lens' ContainerService (Maybe UTCTime) Source #
The Unix timestamp for when the service was created.
containerService_platformVersion :: Lens' ContainerService (Maybe Text) Source #
The platform version on which to run your service. A platform version is
only specified for tasks hosted on Fargate. If one is not specified, the
LATEST platform version is used by default. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
containerService_deployments :: Lens' ContainerService (Maybe [Deployment]) Source #
The current state of deployments for the service.
containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy]) Source #
The placement strategy that determines how tasks for the service are placed.
containerService_serviceName :: Lens' ContainerService (Maybe Text) Source #
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint]) Source #
The placement constraints for the tasks in the service.
containerService_events :: Lens' ContainerService (Maybe [ServiceEvent]) Source #
The event stream for your service. A maximum of 100 of the latest events are displayed.
containerService_pendingCount :: Lens' ContainerService (Maybe Int) Source #
The number of tasks in the cluster that are in the PENDING state.
containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool) Source #
Whether or not the execute command functionality is enabled for the
service. If true, the execute command functionality is enabled for all
containers in tasks as part of the service.
containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer]) Source #
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
containerService_tags :: Lens' ContainerService (Maybe [Tag]) Source #
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int) Source #
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry]) Source #
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
containerService_createdBy :: Lens' ContainerService (Maybe Text) Source #
The principal that created the service.
containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy) Source #
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.Fargate tasks do not support the
DAEMONscheduling strategy.
containerService_taskDefinition :: Lens' ContainerService (Maybe Text) Source #
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
containerService_serviceArn :: Lens' ContainerService (Maybe Text) Source #
The ARN that identifies the service. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the service, the Amazon Web
Services account ID of the service owner, the service namespace, and
then the service name. For example,
arn:aws:ecs:region:012345678910:service/my-service.
containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags) Source #
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
ContainerStateChange
data ContainerStateChange Source #
An object representing a change in state for a container.
See: newContainerStateChange smart constructor.
Constructors
| ContainerStateChange' | |
Fields
| |
Instances
newContainerStateChange :: ContainerStateChange Source #
Create a value of ContainerStateChange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageDigest:ContainerStateChange', containerStateChange_imageDigest - The container image SHA 256 digest.
$sel:status:ContainerStateChange', containerStateChange_status - The status of the container.
$sel:runtimeId:ContainerStateChange', containerStateChange_runtimeId - The ID of the Docker container.
$sel:exitCode:ContainerStateChange', containerStateChange_exitCode - The exit code for the container, if the state change is a result of the
container exiting.
$sel:networkBindings:ContainerStateChange', containerStateChange_networkBindings - Any network bindings associated with the container.
$sel:reason:ContainerStateChange', containerStateChange_reason - The reason for the state change.
$sel:containerName:ContainerStateChange', containerStateChange_containerName - The name of the container.
containerStateChange_imageDigest :: Lens' ContainerStateChange (Maybe Text) Source #
The container image SHA 256 digest.
containerStateChange_status :: Lens' ContainerStateChange (Maybe Text) Source #
The status of the container.
containerStateChange_runtimeId :: Lens' ContainerStateChange (Maybe Text) Source #
The ID of the Docker container.
containerStateChange_exitCode :: Lens' ContainerStateChange (Maybe Int) Source #
The exit code for the container, if the state change is a result of the container exiting.
containerStateChange_networkBindings :: Lens' ContainerStateChange (Maybe [NetworkBinding]) Source #
Any network bindings associated with the container.
containerStateChange_reason :: Lens' ContainerStateChange (Maybe Text) Source #
The reason for the state change.
containerStateChange_containerName :: Lens' ContainerStateChange (Maybe Text) Source #
The name of the container.
Deployment
data Deployment Source #
The details of an Amazon ECS service deployment. This is used only when
a service uses the ECS deployment controller type.
See: newDeployment smart constructor.
Constructors
| Deployment' | |
Fields
| |
Instances
newDeployment :: Deployment Source #
Create a value of Deployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rolloutState:Deployment', deployment_rolloutState - The rolloutState of a service is only returned for services that use
the rolling update (ECS) deployment type that are not behind a Classic
Load Balancer.
The rollout state of the deployment. When a service deployment is
started, it begins in an IN_PROGRESS state. When the service reaches a
steady state, the deployment will transition to a COMPLETED state. If
the service fails to reach a steady state and circuit breaker is
enabled, the deployment will transition to a FAILED state. A
deployment in FAILED state will launch no new tasks. For more
information, see DeploymentCircuitBreaker.
$sel:runningCount:Deployment', deployment_runningCount - The number of tasks in the deployment that are in the RUNNING status.
$sel:status:Deployment', deployment_status - The status of the deployment. The following describes each state:
- PRIMARY
- The most recent deployment of a service.
- ACTIVE
- A service deployment that still has running tasks, but are in the
process of being replaced with a new
PRIMARYdeployment. - INACTIVE
- A deployment that has been completely replaced.
$sel:capacityProviderStrategy:Deployment', deployment_capacityProviderStrategy - The capacity provider strategy that the deployment is using.
$sel:networkConfiguration:Deployment', deployment_networkConfiguration - The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
$sel:desiredCount:Deployment', deployment_desiredCount - The most recent desired count of tasks that was specified for the
service to deploy or maintain.
$sel:updatedAt:Deployment', deployment_updatedAt - The Unix timestamp for when the service deployment was last updated.
$sel:launchType:Deployment', deployment_launchType - The launch type the tasks in the service are using. For more
information, see
Amazon ECS Launch Types
in the Amazon Elastic Container Service Developer Guide.
$sel:id:Deployment', deployment_id - The ID of the deployment.
$sel:createdAt:Deployment', deployment_createdAt - The Unix timestamp for when the service deployment was created.
$sel:platformVersion:Deployment', deployment_platformVersion - The platform version on which your tasks in the service are running. A
platform version is only specified for tasks using the Fargate launch
type. If one is not specified, the LATEST platform version is used by
default. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$sel:pendingCount:Deployment', deployment_pendingCount - The number of tasks in the deployment that are in the PENDING status.
$sel:taskDefinition:Deployment', deployment_taskDefinition - The most recent task definition that was specified for the tasks in the
service to use.
$sel:rolloutStateReason:Deployment', deployment_rolloutStateReason - A description of the rollout state of a deployment.
$sel:failedTasks:Deployment', deployment_failedTasks - The number of consecutively failed tasks in the deployment. A task is
considered a failure if the service scheduler can't launch the task,
the task doesn't transition to a RUNNING state, or if it fails any of
its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
deployment_rolloutState :: Lens' Deployment (Maybe DeploymentRolloutState) Source #
The rolloutState of a service is only returned for services that use
the rolling update (ECS) deployment type that are not behind a Classic
Load Balancer.
The rollout state of the deployment. When a service deployment is
started, it begins in an IN_PROGRESS state. When the service reaches a
steady state, the deployment will transition to a COMPLETED state. If
the service fails to reach a steady state and circuit breaker is
enabled, the deployment will transition to a FAILED state. A
deployment in FAILED state will launch no new tasks. For more
information, see DeploymentCircuitBreaker.
deployment_runningCount :: Lens' Deployment (Maybe Int) Source #
The number of tasks in the deployment that are in the RUNNING status.
deployment_status :: Lens' Deployment (Maybe Text) Source #
The status of the deployment. The following describes each state:
- PRIMARY
- The most recent deployment of a service.
- ACTIVE
- A service deployment that still has running tasks, but are in the
process of being replaced with a new
PRIMARYdeployment. - INACTIVE
- A deployment that has been completely replaced.
deployment_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy that the deployment is using.
deployment_networkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration) Source #
The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
deployment_desiredCount :: Lens' Deployment (Maybe Int) Source #
The most recent desired count of tasks that was specified for the service to deploy or maintain.
deployment_updatedAt :: Lens' Deployment (Maybe UTCTime) Source #
The Unix timestamp for when the service deployment was last updated.
deployment_launchType :: Lens' Deployment (Maybe LaunchType) Source #
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
deployment_id :: Lens' Deployment (Maybe Text) Source #
The ID of the deployment.
deployment_createdAt :: Lens' Deployment (Maybe UTCTime) Source #
The Unix timestamp for when the service deployment was created.
deployment_platformVersion :: Lens' Deployment (Maybe Text) Source #
The platform version on which your tasks in the service are running. A
platform version is only specified for tasks using the Fargate launch
type. If one is not specified, the LATEST platform version is used by
default. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
deployment_pendingCount :: Lens' Deployment (Maybe Int) Source #
The number of tasks in the deployment that are in the PENDING status.
deployment_taskDefinition :: Lens' Deployment (Maybe Text) Source #
The most recent task definition that was specified for the tasks in the service to use.
deployment_rolloutStateReason :: Lens' Deployment (Maybe Text) Source #
A description of the rollout state of a deployment.
deployment_failedTasks :: Lens' Deployment (Maybe Int) Source #
The number of consecutively failed tasks in the deployment. A task is
considered a failure if the service scheduler can't launch the task,
the task doesn't transition to a RUNNING state, or if it fails any of
its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
DeploymentCircuitBreaker
data DeploymentCircuitBreaker Source #
The deployment circuit breaker can only be used for services using the
rolling update (ECS) deployment type that are not behind a Classic
Load Balancer.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.
See: newDeploymentCircuitBreaker smart constructor.
Constructors
| DeploymentCircuitBreaker' | |
Fields
| |
Instances
newDeploymentCircuitBreaker Source #
Arguments
| :: Bool | |
| -> Bool | |
| -> DeploymentCircuitBreaker |
Create a value of DeploymentCircuitBreaker with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enable:DeploymentCircuitBreaker', deploymentCircuitBreaker_enable - Whether to enable the deployment circuit breaker logic for the service.
$sel:rollback:DeploymentCircuitBreaker', deploymentCircuitBreaker_rollback - Whether to enable Amazon ECS to roll back the service if a service
deployment fails. If rollback is enabled, when a service deployment
fails, the service is rolled back to the last deployment that completed
successfully.
deploymentCircuitBreaker_enable :: Lens' DeploymentCircuitBreaker Bool Source #
Whether to enable the deployment circuit breaker logic for the service.
deploymentCircuitBreaker_rollback :: Lens' DeploymentCircuitBreaker Bool Source #
Whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentConfiguration
data DeploymentConfiguration Source #
Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
See: newDeploymentConfiguration smart constructor.
Constructors
| DeploymentConfiguration' | |
Fields
| |
Instances
newDeploymentConfiguration :: DeploymentConfiguration Source #
Create a value of DeploymentConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximumPercent:DeploymentConfiguration', deploymentConfiguration_maximumPercent - If a service is using the rolling update (ECS) deployment type, the
maximum percent parameter represents an upper limit on the number of
tasks in a service that are allowed in the RUNNING or PENDING state
during a deployment, as a percentage of the desired number of tasks
(rounded down to the nearest integer), and while any container instances
are in the DRAINING state if the service contains tasks using the EC2
launch type. This parameter enables you to define the deployment batch
size. For example, if your service has a desired number of four tasks
and a maximum percent value of 200%, the scheduler may start four new
tasks before stopping the four older tasks (provided that the cluster
resources required to do this are available). The default value for
maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL
deployment types and tasks that use the EC2 launch type, the __maximum
percent__ value is set to the default value and is used to define the
upper limit on the number of the tasks in the service that remain in the
RUNNING state while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the
maximum percent value is not used, although it is returned when
describing your service.
$sel:minimumHealthyPercent:DeploymentConfiguration', deploymentConfiguration_minimumHealthyPercent - If a service is using the rolling update (ECS) deployment type, the
minimum healthy percent represents a lower limit on the number of
tasks in a service that must remain in the RUNNING state during a
deployment, as a percentage of the desired number of tasks (rounded up
to the nearest integer), and while any container instances are in the
DRAINING state if the service contains tasks using the EC2 launch
type. This parameter enables you to deploy without using additional
cluster capacity. For example, if your service has a desired number of
four tasks and a minimum healthy percent of 50%, the scheduler may stop
two existing tasks to free up cluster capacity before starting two new
tasks. Tasks for services that do not use a load balancer are
considered healthy if they are in the RUNNING state; tasks for
services that do use a load balancer are considered healthy if they
are in the RUNNING state and they are reported as healthy by the load
balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL
deployment types and tasks that use the EC2 launch type, the __minimum
healthy percent__ value is set to the default value and is used to
define the lower limit on the number of the tasks in the service that
remain in the RUNNING state while the container instances are in the
DRAINING state. If the tasks in the service use the Fargate launch
type, the minimum healthy percent value is not used, although it is
returned when describing your service.
$sel:deploymentCircuitBreaker:DeploymentConfiguration', deploymentConfiguration_deploymentCircuitBreaker - The deployment circuit breaker can only be used for services using the
rolling update (ECS) deployment type.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
deploymentConfiguration_maximumPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #
If a service is using the rolling update (ECS) deployment type, the
maximum percent parameter represents an upper limit on the number of
tasks in a service that are allowed in the RUNNING or PENDING state
during a deployment, as a percentage of the desired number of tasks
(rounded down to the nearest integer), and while any container instances
are in the DRAINING state if the service contains tasks using the EC2
launch type. This parameter enables you to define the deployment batch
size. For example, if your service has a desired number of four tasks
and a maximum percent value of 200%, the scheduler may start four new
tasks before stopping the four older tasks (provided that the cluster
resources required to do this are available). The default value for
maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL
deployment types and tasks that use the EC2 launch type, the __maximum
percent__ value is set to the default value and is used to define the
upper limit on the number of the tasks in the service that remain in the
RUNNING state while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the
maximum percent value is not used, although it is returned when
describing your service.
deploymentConfiguration_minimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #
If a service is using the rolling update (ECS) deployment type, the
minimum healthy percent represents a lower limit on the number of
tasks in a service that must remain in the RUNNING state during a
deployment, as a percentage of the desired number of tasks (rounded up
to the nearest integer), and while any container instances are in the
DRAINING state if the service contains tasks using the EC2 launch
type. This parameter enables you to deploy without using additional
cluster capacity. For example, if your service has a desired number of
four tasks and a minimum healthy percent of 50%, the scheduler may stop
two existing tasks to free up cluster capacity before starting two new
tasks. Tasks for services that do not use a load balancer are
considered healthy if they are in the RUNNING state; tasks for
services that do use a load balancer are considered healthy if they
are in the RUNNING state and they are reported as healthy by the load
balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL
deployment types and tasks that use the EC2 launch type, the __minimum
healthy percent__ value is set to the default value and is used to
define the lower limit on the number of the tasks in the service that
remain in the RUNNING state while the container instances are in the
DRAINING state. If the tasks in the service use the Fargate launch
type, the minimum healthy percent value is not used, although it is
returned when describing your service.
deploymentConfiguration_deploymentCircuitBreaker :: Lens' DeploymentConfiguration (Maybe DeploymentCircuitBreaker) Source #
The deployment circuit breaker can only be used for services using the
rolling update (ECS) deployment type.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentController
data DeploymentController Source #
The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
See: newDeploymentController smart constructor.
Constructors
| DeploymentController' | |
Fields
| |
Instances
newDeploymentController Source #
Create a value of DeploymentController with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':DeploymentController', deploymentController_type - The deployment controller type to use.
There are three deployment controller types available:
- ECS
- The rolling update (
ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
- The blue/green (
CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
- The external (
EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
deploymentController_type :: Lens' DeploymentController DeploymentControllerType Source #
The deployment controller type to use.
There are three deployment controller types available:
- ECS
- The rolling update (
ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
- The blue/green (
CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
- The external (
EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
Device
An object representing a container instance host device.
See: newDevice smart constructor.
Constructors
| Device' | |
Fields
| |
Instances
| Eq Device Source # | |
| Read Device Source # | |
| Show Device Source # | |
| Generic Device Source # | |
| NFData Device Source # | |
Defined in Network.AWS.ECS.Types.Device | |
| Hashable Device Source # | |
Defined in Network.AWS.ECS.Types.Device | |
| ToJSON Device Source # | |
Defined in Network.AWS.ECS.Types.Device | |
| FromJSON Device Source # | |
| type Rep Device Source # | |
Defined in Network.AWS.ECS.Types.Device type Rep Device = D1 ('MetaData "Device" "Network.AWS.ECS.Types.Device" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Device'" 'PrefixI 'True) (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceCgroupPermission])) :*: (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hostPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Device with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:permissions:Device', device_permissions - The explicit permissions to provide to the container for the device. By
default, the container has permissions for read, write, and mknod
for the device.
$sel:containerPath:Device', device_containerPath - The path inside the container at which to expose the host device.
$sel:hostPath:Device', device_hostPath - The path for the device on the host container instance.
device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission]) Source #
The explicit permissions to provide to the container for the device. By
default, the container has permissions for read, write, and mknod
for the device.
device_containerPath :: Lens' Device (Maybe Text) Source #
The path inside the container at which to expose the host device.
device_hostPath :: Lens' Device Text Source #
The path for the device on the host container instance.
DockerVolumeConfiguration
data DockerVolumeConfiguration Source #
This parameter is specified when you are using Docker volumes. Docker
volumes are only supported when you are using the EC2 launch type.
Windows containers only support the use of the local driver. To use
bind mounts, specify a host instead.
See: newDockerVolumeConfiguration smart constructor.
Constructors
| DockerVolumeConfiguration' | |
Fields
| |
Instances
newDockerVolumeConfiguration :: DockerVolumeConfiguration Source #
Create a value of DockerVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:labels:DockerVolumeConfiguration', dockerVolumeConfiguration_labels - Custom metadata to add to your Docker volume. This parameter maps to
Labels in the
Create a volume
section of the
Docker Remote API and the
xxlabel option to
docker volume create.
$sel:scope:DockerVolumeConfiguration', dockerVolumeConfiguration_scope - The scope for the Docker volume that determines its lifecycle. Docker
volumes that are scoped to a task are automatically provisioned when
the task starts and destroyed when the task stops. Docker volumes that
are scoped as shared persist after the task stops.
$sel:driverOpts:DockerVolumeConfiguration', dockerVolumeConfiguration_driverOpts - A map of Docker driver-specific options passed through. This parameter
maps to DriverOpts in the
Create a volume
section of the
Docker Remote API and the
xxopt option to
docker volume create.
$sel:autoprovision:DockerVolumeConfiguration', dockerVolumeConfiguration_autoprovision - If this value is true, the Docker volume is created if it does not
already exist.
This field is only used if the scope is shared.
$sel:driver:DockerVolumeConfiguration', dockerVolumeConfiguration_driver - The Docker volume driver to use. The driver value must match the driver
name provided by Docker because it is used for task placement. If the
driver was installed using the Docker plugin CLI, use docker plugin ls
to retrieve the driver name from your container instance. If the driver
was installed using another method, use Docker plugin discovery to
retrieve the driver name. For more information, see
Docker plugin discovery.
This parameter maps to Driver in the
Create a volume
section of the
Docker Remote API and the
xxdriver option to
docker volume create.
dockerVolumeConfiguration_labels :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text)) Source #
Custom metadata to add to your Docker volume. This parameter maps to
Labels in the
Create a volume
section of the
Docker Remote API and the
xxlabel option to
docker volume create.
dockerVolumeConfiguration_scope :: Lens' DockerVolumeConfiguration (Maybe Scope) Source #
The scope for the Docker volume that determines its lifecycle. Docker
volumes that are scoped to a task are automatically provisioned when
the task starts and destroyed when the task stops. Docker volumes that
are scoped as shared persist after the task stops.
dockerVolumeConfiguration_driverOpts :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text)) Source #
A map of Docker driver-specific options passed through. This parameter
maps to DriverOpts in the
Create a volume
section of the
Docker Remote API and the
xxopt option to
docker volume create.
dockerVolumeConfiguration_autoprovision :: Lens' DockerVolumeConfiguration (Maybe Bool) Source #
If this value is true, the Docker volume is created if it does not
already exist.
This field is only used if the scope is shared.
dockerVolumeConfiguration_driver :: Lens' DockerVolumeConfiguration (Maybe Text) Source #
The Docker volume driver to use. The driver value must match the driver
name provided by Docker because it is used for task placement. If the
driver was installed using the Docker plugin CLI, use docker plugin ls
to retrieve the driver name from your container instance. If the driver
was installed using another method, use Docker plugin discovery to
retrieve the driver name. For more information, see
Docker plugin discovery.
This parameter maps to Driver in the
Create a volume
section of the
Docker Remote API and the
xxdriver option to
docker volume create.
EFSAuthorizationConfig
data EFSAuthorizationConfig Source #
The authorization configuration details for the Amazon EFS file system.
See: newEFSAuthorizationConfig smart constructor.
Constructors
| EFSAuthorizationConfig' | |
Fields
| |
Instances
newEFSAuthorizationConfig :: EFSAuthorizationConfig Source #
Create a value of EFSAuthorizationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPointId:EFSAuthorizationConfig', eFSAuthorizationConfig_accessPointId - The Amazon EFS access point ID to use. If an access point is specified,
the root directory value specified in the EFSVolumeConfiguration must
either be omitted or set to / which will enforce the path set on the
EFS access point. If an access point is used, transit encryption must be
enabled in the EFSVolumeConfiguration. For more information, see
Working with Amazon EFS Access Points
in the Amazon Elastic File System User Guide.
$sel:iam:EFSAuthorizationConfig', eFSAuthorizationConfig_iam - Whether or not to use the Amazon ECS task IAM role defined in a task
definition when mounting the Amazon EFS file system. If enabled, transit
encryption must be enabled in the EFSVolumeConfiguration. If this
parameter is omitted, the default value of DISABLED is used. For more
information, see
Using Amazon EFS Access Points
in the Amazon Elastic Container Service Developer Guide.
eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text) Source #
The Amazon EFS access point ID to use. If an access point is specified,
the root directory value specified in the EFSVolumeConfiguration must
either be omitted or set to / which will enforce the path set on the
EFS access point. If an access point is used, transit encryption must be
enabled in the EFSVolumeConfiguration. For more information, see
Working with Amazon EFS Access Points
in the Amazon Elastic File System User Guide.
eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM) Source #
Whether or not to use the Amazon ECS task IAM role defined in a task
definition when mounting the Amazon EFS file system. If enabled, transit
encryption must be enabled in the EFSVolumeConfiguration. If this
parameter is omitted, the default value of DISABLED is used. For more
information, see
Using Amazon EFS Access Points
in the Amazon Elastic Container Service Developer Guide.
EFSVolumeConfiguration
data EFSVolumeConfiguration Source #
This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer Guide.
See: newEFSVolumeConfiguration smart constructor.
Constructors
| EFSVolumeConfiguration' | |
Fields
| |
Instances
newEFSVolumeConfiguration Source #
Create a value of EFSVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:transitEncryptionPort:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryptionPort - The port to use when sending encrypted data between the Amazon ECS host
and the Amazon EFS server. If you do not specify a transit encryption
port, it will use the port selection strategy that the Amazon EFS mount
helper uses. For more information, see
EFS Mount Helper
in the Amazon Elastic File System User Guide.
$sel:rootDirectory:EFSVolumeConfiguration', eFSVolumeConfiguration_rootDirectory - The directory within the Amazon EFS file system to mount as the root
directory inside the host. If this parameter is omitted, the root of the
Amazon EFS volume will be used. Specifying / will have the same
effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the
root directory parameter must either be omitted or set to / which
will enforce the path set on the EFS access point.
$sel:authorizationConfig:EFSVolumeConfiguration', eFSVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon EFS file system.
$sel:transitEncryption:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryption - Whether or not to enable encryption for Amazon EFS data in transit
between the Amazon ECS host and the Amazon EFS server. Transit
encryption must be enabled if Amazon EFS IAM authorization is used. If
this parameter is omitted, the default value of DISABLED is used. For
more information, see
Encrypting Data in Transit
in the Amazon Elastic File System User Guide.
$sel:fileSystemId:EFSVolumeConfiguration', eFSVolumeConfiguration_fileSystemId - The Amazon EFS file system ID to use.
eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int) Source #
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text) Source #
The directory within the Amazon EFS file system to mount as the root
directory inside the host. If this parameter is omitted, the root of the
Amazon EFS volume will be used. Specifying / will have the same
effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the
root directory parameter must either be omitted or set to / which
will enforce the path set on the EFS access point.
eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig) Source #
The authorization configuration details for the Amazon EFS file system.
eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption) Source #
Whether or not to enable encryption for Amazon EFS data in transit
between the Amazon ECS host and the Amazon EFS server. Transit
encryption must be enabled if Amazon EFS IAM authorization is used. If
this parameter is omitted, the default value of DISABLED is used. For
more information, see
Encrypting Data in Transit
in the Amazon Elastic File System User Guide.
eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text Source #
The Amazon EFS file system ID to use.
EnvironmentFile
data EnvironmentFile Source #
A list of files containing the environment variables to pass to a
container. You can specify up to ten environment files. The file must
have a .env file extension. Each line in an environment file should
contain an environment variable in VARIABLE=VALUE format. Lines
beginning with # are treated as comments and are ignored. For more
information on the environment variable file syntax, see
Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition, they take precedence over the
variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they are processed
from the top down. It is recommended to use unique variable names. For
more information, see
Specifying environment variables
in the Amazon Elastic Container Service Developer Guide.
This field is only valid for containers in Fargate tasks that use
platform version 1.4.0 or later.
See: newEnvironmentFile smart constructor.
Constructors
| EnvironmentFile' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EnvironmentFileType | |
| -> EnvironmentFile |
Create a value of EnvironmentFile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:EnvironmentFile', environmentFile_value - The Amazon Resource Name (ARN) of the Amazon S3 object containing the
environment variable file.
$sel:type':EnvironmentFile', environmentFile_type - The file type to use. The only supported value is s3.
environmentFile_value :: Lens' EnvironmentFile Text Source #
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
environmentFile_type :: Lens' EnvironmentFile EnvironmentFileType Source #
The file type to use. The only supported value is s3.
EphemeralStorage
data EphemeralStorage Source #
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.
This parameter is only supported for tasks hosted on Fargate using
platform version 1.4.0 or later.
See: newEphemeralStorage smart constructor.
Constructors
| EphemeralStorage' | |
Instances
Arguments
| :: Int | |
| -> EphemeralStorage |
Create a value of EphemeralStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sizeInGiB:EphemeralStorage', ephemeralStorage_sizeInGiB - The total amount, in GiB, of ephemeral storage to set for the task. The
minimum supported value is 21 GiB and the maximum supported value is
200 GiB.
ephemeralStorage_sizeInGiB :: Lens' EphemeralStorage Int Source #
The total amount, in GiB, of ephemeral storage to set for the task. The
minimum supported value is 21 GiB and the maximum supported value is
200 GiB.
ExecuteCommandConfiguration
data ExecuteCommandConfiguration Source #
The details of the execute command configuration.
See: newExecuteCommandConfiguration smart constructor.
Constructors
| ExecuteCommandConfiguration' | |
Fields
| |
Instances
newExecuteCommandConfiguration :: ExecuteCommandConfiguration Source #
Create a value of ExecuteCommandConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logging:ExecuteCommandConfiguration', executeCommandConfiguration_logging - The log setting to use for redirecting logs for your execute command
results. The following log settings are available.
NONE: The execute command session is not logged.DEFAULT: Theawslogsconfiguration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogslog driver is configured in the task definition, the output won't be logged.OVERRIDE: Specify the logging details as a part oflogConfiguration. If theOVERRIDElogging option is specified, thelogConfigurationis required.
$sel:kmsKeyId:ExecuteCommandConfiguration', executeCommandConfiguration_kmsKeyId - Specify an Key Management Service key ID to encrypt the data between the
local client and the container.
$sel:logConfiguration:ExecuteCommandConfiguration', executeCommandConfiguration_logConfiguration - The log configuration for the results of the execute command actions.
The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE is specified, a logConfiguration must be provided.
executeCommandConfiguration_logging :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogging) Source #
The log setting to use for redirecting logs for your execute command results. The following log settings are available.
NONE: The execute command session is not logged.DEFAULT: Theawslogsconfiguration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogslog driver is configured in the task definition, the output won't be logged.OVERRIDE: Specify the logging details as a part oflogConfiguration. If theOVERRIDElogging option is specified, thelogConfigurationis required.
executeCommandConfiguration_kmsKeyId :: Lens' ExecuteCommandConfiguration (Maybe Text) Source #
Specify an Key Management Service key ID to encrypt the data between the local client and the container.
executeCommandConfiguration_logConfiguration :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogConfiguration) Source #
The log configuration for the results of the execute command actions.
The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE is specified, a logConfiguration must be provided.
ExecuteCommandLogConfiguration
data ExecuteCommandLogConfiguration Source #
The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.
See: newExecuteCommandLogConfiguration smart constructor.
Constructors
| ExecuteCommandLogConfiguration' | |
Fields
| |
Instances
newExecuteCommandLogConfiguration :: ExecuteCommandLogConfiguration Source #
Create a value of ExecuteCommandLogConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogGroupName:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_cloudWatchLogGroupName - The name of the CloudWatch log group to send logs to.
The CloudWatch log group must already be created.
$sel:cloudWatchEncryptionEnabled:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_cloudWatchEncryptionEnabled - Whether or not to enable encryption on the CloudWatch logs. If not
specified, encryption will be disabled.
$sel:s3EncryptionEnabled:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3EncryptionEnabled - Whether or not to enable encryption on the CloudWatch logs. If not
specified, encryption will be disabled.
$sel:s3KeyPrefix:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3KeyPrefix - An optional folder in the S3 bucket to place logs in.
$sel:s3BucketName:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3BucketName - The name of the S3 bucket to send logs to.
The S3 bucket must already be created.
executeCommandLogConfiguration_cloudWatchLogGroupName :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #
The name of the CloudWatch log group to send logs to.
The CloudWatch log group must already be created.
executeCommandLogConfiguration_cloudWatchEncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool) Source #
Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
executeCommandLogConfiguration_s3EncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool) Source #
Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
executeCommandLogConfiguration_s3KeyPrefix :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #
An optional folder in the S3 bucket to place logs in.
executeCommandLogConfiguration_s3BucketName :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #
The name of the S3 bucket to send logs to.
The S3 bucket must already be created.
FSxWindowsFileServerAuthorizationConfig
data FSxWindowsFileServerAuthorizationConfig Source #
The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon Elastic Container Service API Reference.
For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.
See: newFSxWindowsFileServerAuthorizationConfig smart constructor.
Constructors
| FSxWindowsFileServerAuthorizationConfig' | |
Fields
| |
Instances
newFSxWindowsFileServerAuthorizationConfig Source #
Arguments
| :: Text |
|
| -> Text | |
| -> FSxWindowsFileServerAuthorizationConfig |
Create a value of FSxWindowsFileServerAuthorizationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:credentialsParameter:FSxWindowsFileServerAuthorizationConfig', fSxWindowsFileServerAuthorizationConfig_credentialsParameter - The authorization credential option to use. The authorization credential
options can be provided using either the Amazon Resource Name (ARN) of
an Secrets Manager secret or SSM Parameter Store parameter. The ARNs
refer to the stored credentials.
$sel:domain:FSxWindowsFileServerAuthorizationConfig', fSxWindowsFileServerAuthorizationConfig_domain - A fully qualified domain name hosted by an
Directory Service
Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
fSxWindowsFileServerAuthorizationConfig_credentialsParameter :: Lens' FSxWindowsFileServerAuthorizationConfig Text Source #
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARNs refer to the stored credentials.
fSxWindowsFileServerAuthorizationConfig_domain :: Lens' FSxWindowsFileServerAuthorizationConfig Text Source #
A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
FSxWindowsFileServerVolumeConfiguration
data FSxWindowsFileServerVolumeConfiguration Source #
This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage.
For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.
See: newFSxWindowsFileServerVolumeConfiguration smart constructor.
Constructors
| FSxWindowsFileServerVolumeConfiguration' | |
Fields
| |
Instances
newFSxWindowsFileServerVolumeConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> FSxWindowsFileServerAuthorizationConfig |
|
| -> FSxWindowsFileServerVolumeConfiguration |
Create a value of FSxWindowsFileServerVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemId:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_fileSystemId - The Amazon FSx for Windows File Server file system ID to use.
$sel:rootDirectory:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_rootDirectory - The directory within the Amazon FSx for Windows File Server file system
to mount as the root directory inside the host.
$sel:authorizationConfig:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon FSx for Windows
File Server file system.
fSxWindowsFileServerVolumeConfiguration_fileSystemId :: Lens' FSxWindowsFileServerVolumeConfiguration Text Source #
The Amazon FSx for Windows File Server file system ID to use.
fSxWindowsFileServerVolumeConfiguration_rootDirectory :: Lens' FSxWindowsFileServerVolumeConfiguration Text Source #
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
fSxWindowsFileServerVolumeConfiguration_authorizationConfig :: Lens' FSxWindowsFileServerVolumeConfiguration FSxWindowsFileServerAuthorizationConfig Source #
The authorization configuration details for the Amazon FSx for Windows File Server file system.
Failure
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
See: newFailure smart constructor.
Constructors
| Failure' | |
Instances
| Eq Failure Source # | |
| Read Failure Source # | |
| Show Failure Source # | |
| Generic Failure Source # | |
| NFData Failure Source # | |
Defined in Network.AWS.ECS.Types.Failure | |
| Hashable Failure Source # | |
Defined in Network.AWS.ECS.Types.Failure | |
| FromJSON Failure Source # | |
| type Rep Failure Source # | |
Defined in Network.AWS.ECS.Types.Failure type Rep Failure = D1 ('MetaData "Failure" "Network.AWS.ECS.Types.Failure" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Failure'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newFailure :: Failure Source #
Create a value of Failure with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Failure', failure_arn - The Amazon Resource Name (ARN) of the failed resource.
$sel:reason:Failure', failure_reason - The reason for the failure.
$sel:detail:Failure', failure_detail - The details of the failure.
failure_arn :: Lens' Failure (Maybe Text) Source #
The Amazon Resource Name (ARN) of the failed resource.
FirelensConfiguration
data FirelensConfiguration Source #
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
See: newFirelensConfiguration smart constructor.
Constructors
| FirelensConfiguration' | |
Fields
| |
Instances
newFirelensConfiguration Source #
Create a value of FirelensConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:FirelensConfiguration', firelensConfiguration_options - The options to use when configuring the log router. This field is
optional and can be used to specify a custom configuration file or to
add additional metadata, such as the task, task definition, cluster, and
container instance details to the log event. If specified, the syntax to
use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}.
For more information, see
Creating a Task Definition that Uses a FireLens Configuration
in the Amazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file type.
$sel:type':FirelensConfiguration', firelensConfiguration_type - The log router to use. The valid values are fluentd or fluentbit.
firelensConfiguration_options :: Lens' FirelensConfiguration (Maybe (HashMap Text Text)) Source #
The options to use when configuring the log router. This field is
optional and can be used to specify a custom configuration file or to
add additional metadata, such as the task, task definition, cluster, and
container instance details to the log event. If specified, the syntax to
use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}.
For more information, see
Creating a Task Definition that Uses a FireLens Configuration
in the Amazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file type.
firelensConfiguration_type :: Lens' FirelensConfiguration FirelensConfigurationType Source #
The log router to use. The valid values are fluentd or fluentbit.
HealthCheck
data HealthCheck Source #
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.
The following describes the possible healthStatus values for a
container:
HEALTHY-The container health check has passed successfully.UNHEALTHY-The container health check has failed.UNKNOWN-The container health check is being evaluated or there is no container health check defined.
The following describes the possible healthStatus values for a task.
The container health check status of nonessential containers do not have
an effect on the health status of a task.
HEALTHY-All essential containers within the task have passed their health checks.UNHEALTHY-One or more essential containers have failed their health check.UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.
The following are notes about container health check support:
- Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
- Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Fargate Platform Versions.
- Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
See: newHealthCheck smart constructor.
Constructors
| HealthCheck' | |
Fields
| |
Instances
newHealthCheck :: HealthCheck Source #
Create a value of HealthCheck with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retries:HealthCheck', healthCheck_retries - The number of times to retry a failed health check before the container
is considered unhealthy. You may specify between 1 and 10 retries. The
default value is 3.
$sel:timeout:HealthCheck', healthCheck_timeout - The time period in seconds to wait for a health check to succeed before
it is considered a failure. You may specify between 2 and 60 seconds.
The default value is 5.
$sel:startPeriod:HealthCheck', healthCheck_startPeriod - The optional grace period within which to provide containers time to
bootstrap before failed health checks count towards the maximum number
of retries. You may specify between 0 and 300 seconds. The startPeriod
is disabled by default.
If a health check succeeds within the startPeriod, then the container
is considered healthy and any subsequent failures count toward the
maximum number of retries.
$sel:interval:HealthCheck', healthCheck_interval - The time period in seconds between each health check execution. You may
specify between 5 and 300 seconds. The default value is 30 seconds.
$sel:command:HealthCheck', healthCheck_command - A string array representing the command that the container runs to
determine if it is healthy. The string array must start with CMD to
execute the command arguments directly, or CMD-SHELL to run the
command with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, you should enclose the list of commands in brackets, as shown below.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You do not need to include the brackets when you use the Amazon Web Services Management Consoleas shown below.
"CMD-SHELL", "curl -f http://localhost/ || exit 1"
An exit code of 0 indicates success, and non-zero exit code indicates
failure. For more information, see HealthCheck in the
Create a container
section of the
Docker Remote API.
healthCheck_retries :: Lens' HealthCheck (Maybe Int) Source #
The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
healthCheck_timeout :: Lens' HealthCheck (Maybe Int) Source #
The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
healthCheck_startPeriod :: Lens' HealthCheck (Maybe Int) Source #
The optional grace period within which to provide containers time to
bootstrap before failed health checks count towards the maximum number
of retries. You may specify between 0 and 300 seconds. The startPeriod
is disabled by default.
If a health check succeeds within the startPeriod, then the container
is considered healthy and any subsequent failures count toward the
maximum number of retries.
healthCheck_interval :: Lens' HealthCheck (Maybe Int) Source #
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
healthCheck_command :: Lens' HealthCheck [Text] Source #
A string array representing the command that the container runs to
determine if it is healthy. The string array must start with CMD to
execute the command arguments directly, or CMD-SHELL to run the
command with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, you should enclose the list of commands in brackets, as shown below.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You do not need to include the brackets when you use the Amazon Web Services Management Consoleas shown below.
"CMD-SHELL", "curl -f http://localhost/ || exit 1"
An exit code of 0 indicates success, and non-zero exit code indicates
failure. For more information, see HealthCheck in the
Create a container
section of the
Docker Remote API.
HostEntry
Hostnames and IP address entries that are added to the /etc/hosts
file of a container via the extraHosts parameter of its
ContainerDefinition.
See: newHostEntry smart constructor.
Constructors
| HostEntry' | |
Instances
| Eq HostEntry Source # | |
| Read HostEntry Source # | |
| Show HostEntry Source # | |
| Generic HostEntry Source # | |
| NFData HostEntry Source # | |
Defined in Network.AWS.ECS.Types.HostEntry | |
| Hashable HostEntry Source # | |
Defined in Network.AWS.ECS.Types.HostEntry | |
| ToJSON HostEntry Source # | |
Defined in Network.AWS.ECS.Types.HostEntry | |
| FromJSON HostEntry Source # | |
| type Rep HostEntry Source # | |
Defined in Network.AWS.ECS.Types.HostEntry type Rep HostEntry = D1 ('MetaData "HostEntry" "Network.AWS.ECS.Types.HostEntry" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "HostEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ipAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of HostEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostname:HostEntry', hostEntry_hostname - The hostname to use in the /etc/hosts entry.
$sel:ipAddress:HostEntry', hostEntry_ipAddress - The IP address to use in the /etc/hosts entry.
HostVolumeProperties
data HostVolumeProperties Source #
Details on a container instance bind mount host volume.
See: newHostVolumeProperties smart constructor.
Constructors
| HostVolumeProperties' | |
Fields
| |
Instances
newHostVolumeProperties :: HostVolumeProperties Source #
Create a value of HostVolumeProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourcePath:HostVolumeProperties', hostVolumeProperties_sourcePath - When the host parameter is used, specify a sourcePath to declare the
path on the host container instance that is presented to the container.
If this parameter is empty, then the Docker daemon has assigned a host
path for you. If the host parameter contains a sourcePath file
location, then the data volume persists at the specified location on the
host container instance until you delete it manually. If the
sourcePath value does not exist on the host container instance, the
Docker daemon creates it. If the location does exist, the contents of
the source path folder are exported.
If you are using the Fargate launch type, the sourcePath parameter is
not supported.
hostVolumeProperties_sourcePath :: Lens' HostVolumeProperties (Maybe Text) Source #
When the host parameter is used, specify a sourcePath to declare the
path on the host container instance that is presented to the container.
If this parameter is empty, then the Docker daemon has assigned a host
path for you. If the host parameter contains a sourcePath file
location, then the data volume persists at the specified location on the
host container instance until you delete it manually. If the
sourcePath value does not exist on the host container instance, the
Docker daemon creates it. If the location does exist, the contents of
the source path folder are exported.
If you are using the Fargate launch type, the sourcePath parameter is
not supported.
InferenceAccelerator
data InferenceAccelerator Source #
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
See: newInferenceAccelerator smart constructor.
Constructors
| InferenceAccelerator' | |
Fields
| |
Instances
newInferenceAccelerator Source #
Arguments
| :: Text | |
| -> Text | |
| -> InferenceAccelerator |
Create a value of InferenceAccelerator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceName:InferenceAccelerator', inferenceAccelerator_deviceName - The Elastic Inference accelerator device name. The deviceName must
also be referenced in a container definition as a ResourceRequirement.
$sel:deviceType:InferenceAccelerator', inferenceAccelerator_deviceType - The Elastic Inference accelerator type to use.
inferenceAccelerator_deviceName :: Lens' InferenceAccelerator Text Source #
The Elastic Inference accelerator device name. The deviceName must
also be referenced in a container definition as a ResourceRequirement.
inferenceAccelerator_deviceType :: Lens' InferenceAccelerator Text Source #
The Elastic Inference accelerator type to use.
InferenceAcceleratorOverride
data InferenceAcceleratorOverride Source #
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
See: newInferenceAcceleratorOverride smart constructor.
Constructors
| InferenceAcceleratorOverride' | |
Fields
| |
Instances
newInferenceAcceleratorOverride :: InferenceAcceleratorOverride Source #
Create a value of InferenceAcceleratorOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceName:InferenceAcceleratorOverride', inferenceAcceleratorOverride_deviceName - The Elastic Inference accelerator device name to override for the task.
This parameter must match a deviceName specified in the task
definition.
$sel:deviceType:InferenceAcceleratorOverride', inferenceAcceleratorOverride_deviceType - The Elastic Inference accelerator type to use.
inferenceAcceleratorOverride_deviceName :: Lens' InferenceAcceleratorOverride (Maybe Text) Source #
The Elastic Inference accelerator device name to override for the task.
This parameter must match a deviceName specified in the task
definition.
inferenceAcceleratorOverride_deviceType :: Lens' InferenceAcceleratorOverride (Maybe Text) Source #
The Elastic Inference accelerator type to use.
KernelCapabilities
data KernelCapabilities Source #
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
See: newKernelCapabilities smart constructor.
Constructors
| KernelCapabilities' | |
Fields
| |
Instances
newKernelCapabilities :: KernelCapabilities Source #
Create a value of KernelCapabilities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:drop:KernelCapabilities', kernelCapabilities_drop - The Linux capabilities for the container that have been removed from the
default configuration provided by Docker. This parameter maps to
CapDrop in the
Create a container
section of the
Docker Remote API and the
--cap-drop option to
docker run.
Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
$sel:add:KernelCapabilities', kernelCapabilities_add - The Linux capabilities for the container that have been added to the
default configuration provided by Docker. This parameter maps to
CapAdd in the
Create a container
section of the
Docker Remote API and the
--cap-add option to
docker run.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel
capability.
Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
kernelCapabilities_drop :: Lens' KernelCapabilities (Maybe [Text]) Source #
The Linux capabilities for the container that have been removed from the
default configuration provided by Docker. This parameter maps to
CapDrop in the
Create a container
section of the
Docker Remote API and the
--cap-drop option to
docker run.
Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
kernelCapabilities_add :: Lens' KernelCapabilities (Maybe [Text]) Source #
The Linux capabilities for the container that have been added to the
default configuration provided by Docker. This parameter maps to
CapAdd in the
Create a container
section of the
Docker Remote API and the
--cap-add option to
docker run.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel
capability.
Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
KeyValuePair
data KeyValuePair Source #
A key-value pair object.
See: newKeyValuePair smart constructor.
Constructors
| KeyValuePair' | |
Instances
newKeyValuePair :: KeyValuePair Source #
Create a value of KeyValuePair with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:KeyValuePair', keyValuePair_name - The name of the key-value pair. For environment variables, this is the
name of the environment variable.
$sel:value:KeyValuePair', keyValuePair_value - The value of the key-value pair. For environment variables, this is the
value of the environment variable.
keyValuePair_name :: Lens' KeyValuePair (Maybe Text) Source #
The name of the key-value pair. For environment variables, this is the name of the environment variable.
keyValuePair_value :: Lens' KeyValuePair (Maybe Text) Source #
The value of the key-value pair. For environment variables, this is the value of the environment variable.
LinuxParameters
data LinuxParameters Source #
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
See: newLinuxParameters smart constructor.
Constructors
| LinuxParameters' | |
Fields
| |
Instances
newLinuxParameters :: LinuxParameters Source #
Create a value of LinuxParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tmpfs:LinuxParameters', linuxParameters_tmpfs - The container path, mount options, and size (in MiB) of the tmpfs mount.
This parameter maps to the --tmpfs option to
docker run.
If you are using tasks that use the Fargate launch type, the tmpfs
parameter is not supported.
$sel:maxSwap:LinuxParameters', linuxParameters_maxSwap - The total amount of swap memory (in MiB) a container can use. This
parameter will be translated to the --memory-swap option to
docker run
where the value would be the sum of the container memory plus the
maxSwap value.
If a maxSwap value of 0 is specified, the container will not use
swap. Accepted values are 0 or any positive integer. If the maxSwap
parameter is omitted, the container will use the swap configuration for
the container instance it is running on. A maxSwap value must be set
for the swappiness parameter to be used.
If you are using tasks that use the Fargate launch type, the maxSwap
parameter is not supported.
$sel:capabilities:LinuxParameters', linuxParameters_capabilities - The Linux capabilities for the container that are added to or dropped
from the default configuration provided by Docker.
For tasks that use the Fargate launch type, capabilities is supported
for all platform versions but the add parameter is only supported if
using platform version 1.4.0 or later.
$sel:devices:LinuxParameters', linuxParameters_devices - Any host devices to expose to the container. This parameter maps to
Devices in the
Create a container
section of the
Docker Remote API and the
--device option to
docker run.
If you are using tasks that use the Fargate launch type, the devices
parameter is not supported.
$sel:swappiness:LinuxParameters', linuxParameters_swappiness - This allows you to tune a container's memory swappiness behavior. A
swappiness value of 0 will cause swapping to not happen unless
absolutely necessary. A swappiness value of 100 will cause pages to
be swapped very aggressively. Accepted values are whole numbers between
0 and 100. If the swappiness parameter is not specified, a default
value of 60 is used. If a value is not specified for maxSwap then
this parameter is ignored. This parameter maps to the
--memory-swappiness option to
docker run.
If you are using tasks that use the Fargate launch type, the
swappiness parameter is not supported.
$sel:initProcessEnabled:LinuxParameters', linuxParameters_initProcessEnabled - Run an init process inside the container that forwards signals and
reaps processes. This parameter maps to the --init option to
docker run.
This parameter requires version 1.25 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
$sel:sharedMemorySize:LinuxParameters', linuxParameters_sharedMemorySize - The value for the size (in MiB) of the /dev/shm volume. This
parameter maps to the --shm-size option to
docker run.
If you are using tasks that use the Fargate launch type, the
sharedMemorySize parameter is not supported.
linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs]) Source #
The container path, mount options, and size (in MiB) of the tmpfs mount.
This parameter maps to the --tmpfs option to
docker run.
If you are using tasks that use the Fargate launch type, the tmpfs
parameter is not supported.
linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int) Source #
The total amount of swap memory (in MiB) a container can use. This
parameter will be translated to the --memory-swap option to
docker run
where the value would be the sum of the container memory plus the
maxSwap value.
If a maxSwap value of 0 is specified, the container will not use
swap. Accepted values are 0 or any positive integer. If the maxSwap
parameter is omitted, the container will use the swap configuration for
the container instance it is running on. A maxSwap value must be set
for the swappiness parameter to be used.
If you are using tasks that use the Fargate launch type, the maxSwap
parameter is not supported.
linuxParameters_capabilities :: Lens' LinuxParameters (Maybe KernelCapabilities) Source #
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
For tasks that use the Fargate launch type, capabilities is supported
for all platform versions but the add parameter is only supported if
using platform version 1.4.0 or later.
linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device]) Source #
Any host devices to expose to the container. This parameter maps to
Devices in the
Create a container
section of the
Docker Remote API and the
--device option to
docker run.
If you are using tasks that use the Fargate launch type, the devices
parameter is not supported.
linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int) Source #
This allows you to tune a container's memory swappiness behavior. A
swappiness value of 0 will cause swapping to not happen unless
absolutely necessary. A swappiness value of 100 will cause pages to
be swapped very aggressively. Accepted values are whole numbers between
0 and 100. If the swappiness parameter is not specified, a default
value of 60 is used. If a value is not specified for maxSwap then
this parameter is ignored. This parameter maps to the
--memory-swappiness option to
docker run.
If you are using tasks that use the Fargate launch type, the
swappiness parameter is not supported.
linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool) Source #
Run an init process inside the container that forwards signals and
reaps processes. This parameter maps to the --init option to
docker run.
This parameter requires version 1.25 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int) Source #
The value for the size (in MiB) of the /dev/shm volume. This
parameter maps to the --shm-size option to
docker run.
If you are using tasks that use the Fargate launch type, the
sharedMemorySize parameter is not supported.
LoadBalancer
data LoadBalancer Source #
The load balancer configuration to use with a service or task set.
For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.
See: newLoadBalancer smart constructor.
Constructors
| LoadBalancer' | |
Fields
| |
Instances
newLoadBalancer :: LoadBalancer Source #
Create a value of LoadBalancer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetGroupArn:LoadBalancer', loadBalancer_targetGroupArn - The full Amazon Resource Name (ARN) of the Elastic Load Balancing target
group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.
For services using the ECS deployment controller, you can specify one
or multiple target groups. For more information, see
Registering Multiple Target Groups with a Service
in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you are
required to define two target groups for the load balancer. For more
information, see
Blue/Green Deployment with CodeDeploy
in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode (which
is required for the Fargate launch type), you must choose ip as the
target type, not instance, when creating your target groups because
tasks that use the awsvpc network mode are associated with an elastic
network interface, not an Amazon EC2 instance.
$sel:containerPort:LoadBalancer', loadBalancer_containerPort - The port on the container to associate with the load balancer. This port
must correspond to a containerPort in the task definition the tasks in
the service are using. For tasks that use the EC2 launch type, the
container instance they are launched on must allow ingress traffic on
the hostPort of the port mapping.
$sel:containerName:LoadBalancer', loadBalancer_containerName - The name of the container (as it appears in a container definition) to
associate with the load balancer.
$sel:loadBalancerName:LoadBalancer', loadBalancer_loadBalancerName - The name of the load balancer to associate with the Amazon ECS service
or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
loadBalancer_targetGroupArn :: Lens' LoadBalancer (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.
For services using the ECS deployment controller, you can specify one
or multiple target groups. For more information, see
Registering Multiple Target Groups with a Service
in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you are
required to define two target groups for the load balancer. For more
information, see
Blue/Green Deployment with CodeDeploy
in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode (which
is required for the Fargate launch type), you must choose ip as the
target type, not instance, when creating your target groups because
tasks that use the awsvpc network mode are associated with an elastic
network interface, not an Amazon EC2 instance.
loadBalancer_containerPort :: Lens' LoadBalancer (Maybe Int) Source #
The port on the container to associate with the load balancer. This port
must correspond to a containerPort in the task definition the tasks in
the service are using. For tasks that use the EC2 launch type, the
container instance they are launched on must allow ingress traffic on
the hostPort of the port mapping.
loadBalancer_containerName :: Lens' LoadBalancer (Maybe Text) Source #
The name of the container (as it appears in a container definition) to associate with the load balancer.
loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text) Source #
The name of the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
LogConfiguration
data LogConfiguration Source #
The log configuration for the container. This parameter maps to
LogConfig in the
Create a container
section of the
Docker Remote API and the
--log-driver option to
docker run .
By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
The following should be noted when specifying a log configuration for your containers:
- Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.
- This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
- For tasks hosted on Amazon EC2 instances, the Amazon ECS container
agent must register the available logging drivers with the
ECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide. - For tasks on Fargate, because you do not have access to the underlying infrastructure your tasks are hosted on, any additional software needed will have to be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
See: newLogConfiguration smart constructor.
Constructors
| LogConfiguration' | |
Fields
| |
Instances
Arguments
| :: LogDriver | |
| -> LogConfiguration |
Create a value of LogConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:LogConfiguration', logConfiguration_options - The configuration options to send to the log driver. This parameter
requires version 1.19 of the Docker Remote API or greater on your
container instance. To check the Docker Remote API version on your
container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
$sel:secretOptions:LogConfiguration', logConfiguration_secretOptions - The secrets to pass to the log configuration. For more information, see
Specifying Sensitive Data
in the Amazon Elastic Container Service Developer Guide.
$sel:logDriver:LogConfiguration', logConfiguration_logDriver - The log driver to use for the container.
For tasks on Fargate, the supported log drivers are awslogs, splunk,
and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs, fluentd, gelf, json-file, journald,
logentries,syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see
Using the awslogs log driver
in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see
Custom log routing
in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.
logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text)) Source #
The configuration options to send to the log driver. This parameter
requires version 1.19 of the Docker Remote API or greater on your
container instance. To check the Docker Remote API version on your
container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret]) Source #
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
logConfiguration_logDriver :: Lens' LogConfiguration LogDriver Source #
The log driver to use for the container.
For tasks on Fargate, the supported log drivers are awslogs, splunk,
and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs, fluentd, gelf, json-file, journald,
logentries,syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see
Using the awslogs log driver
in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see
Custom log routing
in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.
ManagedAgent
data ManagedAgent Source #
Details about the managed agent status for the container.
See: newManagedAgent smart constructor.
Constructors
| ManagedAgent' | |
Fields
| |
Instances
newManagedAgent :: ManagedAgent Source #
Create a value of ManagedAgent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ManagedAgent', managedAgent_name - The name of the managed agent. When the execute command feature is
enabled, the managed agent name is ExecuteCommandAgent.
$sel:reason:ManagedAgent', managedAgent_reason - The reason for why the managed agent is in the state it is in.
$sel:lastStatus:ManagedAgent', managedAgent_lastStatus - The last known status of the managed agent.
$sel:lastStartedAt:ManagedAgent', managedAgent_lastStartedAt - The Unix timestamp for when the managed agent was last started.
managedAgent_name :: Lens' ManagedAgent (Maybe ManagedAgentName) Source #
The name of the managed agent. When the execute command feature is
enabled, the managed agent name is ExecuteCommandAgent.
managedAgent_reason :: Lens' ManagedAgent (Maybe Text) Source #
The reason for why the managed agent is in the state it is in.
managedAgent_lastStatus :: Lens' ManagedAgent (Maybe Text) Source #
The last known status of the managed agent.
managedAgent_lastStartedAt :: Lens' ManagedAgent (Maybe UTCTime) Source #
The Unix timestamp for when the managed agent was last started.
ManagedAgentStateChange
data ManagedAgentStateChange Source #
An object representing a change in state for a managed agent.
See: newManagedAgentStateChange smart constructor.
Constructors
| ManagedAgentStateChange' | |
Fields
| |
Instances
newManagedAgentStateChange Source #
Arguments
| :: Text | |
| -> ManagedAgentName | |
| -> Text | |
| -> ManagedAgentStateChange |
Create a value of ManagedAgentStateChange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reason:ManagedAgentStateChange', managedAgentStateChange_reason - The reason for the status of the managed agent.
$sel:containerName:ManagedAgentStateChange', managedAgentStateChange_containerName - The name of the container associated with the managed agent.
$sel:managedAgentName:ManagedAgentStateChange', managedAgentStateChange_managedAgentName - The name of the managed agent.
$sel:status:ManagedAgentStateChange', managedAgentStateChange_status - The status of the managed agent.
managedAgentStateChange_reason :: Lens' ManagedAgentStateChange (Maybe Text) Source #
The reason for the status of the managed agent.
managedAgentStateChange_containerName :: Lens' ManagedAgentStateChange Text Source #
The name of the container associated with the managed agent.
managedAgentStateChange_managedAgentName :: Lens' ManagedAgentStateChange ManagedAgentName Source #
The name of the managed agent.
managedAgentStateChange_status :: Lens' ManagedAgentStateChange Text Source #
The status of the managed agent.
ManagedScaling
data ManagedScaling Source #
The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is enabled, Amazon ECS manages the scale-in and
scale-out actions of the Auto Scaling group. Amazon ECS manages a target
tracking scaling policy using an Amazon ECS-managed CloudWatch metric
with the specified targetCapacity value as the target value for the
metric. For more information, see
Using Managed Scaling
in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.
See: newManagedScaling smart constructor.
Constructors
| ManagedScaling' | |
Fields
| |
Instances
newManagedScaling :: ManagedScaling Source #
Create a value of ManagedScaling with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ManagedScaling', managedScaling_status - Whether or not to enable managed scaling for the capacity provider.
$sel:maximumScalingStepSize:ManagedScaling', managedScaling_maximumScalingStepSize - The maximum number of container instances that Amazon ECS will scale in
or scale out at one time. If this parameter is omitted, the default
value of 10000 is used.
$sel:minimumScalingStepSize:ManagedScaling', managedScaling_minimumScalingStepSize - The minimum number of container instances that Amazon ECS will scale in
or scale out at one time. If this parameter is omitted, the default
value of 1 is used.
$sel:instanceWarmupPeriod:ManagedScaling', managedScaling_instanceWarmupPeriod - The period of time, in seconds, after a newly launched Amazon EC2
instance can contribute to CloudWatch metrics for Auto Scaling group. If
this parameter is omitted, the default value of 300 seconds is used.
$sel:targetCapacity:ManagedScaling', managedScaling_targetCapacity - The target capacity value for the capacity provider. The specified value
must be greater than 0 and less than or equal to 100. A value of
100 will result in the Amazon EC2 instances in your Auto Scaling group
being completely utilized.
managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus) Source #
Whether or not to enable managed scaling for the capacity provider.
managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #
The maximum number of container instances that Amazon ECS will scale in
or scale out at one time. If this parameter is omitted, the default
value of 10000 is used.
managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #
The minimum number of container instances that Amazon ECS will scale in
or scale out at one time. If this parameter is omitted, the default
value of 1 is used.
managedScaling_instanceWarmupPeriod :: Lens' ManagedScaling (Maybe Natural) Source #
The period of time, in seconds, after a newly launched Amazon EC2
instance can contribute to CloudWatch metrics for Auto Scaling group. If
this parameter is omitted, the default value of 300 seconds is used.
managedScaling_targetCapacity :: Lens' ManagedScaling (Maybe Natural) Source #
The target capacity value for the capacity provider. The specified value
must be greater than 0 and less than or equal to 100. A value of
100 will result in the Amazon EC2 instances in your Auto Scaling group
being completely utilized.
MountPoint
data MountPoint Source #
Details on a volume mount point that is used in a container definition.
See: newMountPoint smart constructor.
Constructors
| MountPoint' | |
Fields
| |
Instances
newMountPoint :: MountPoint Source #
Create a value of MountPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:readOnly:MountPoint', mountPoint_readOnly - If this value is true, the container has read-only access to the
volume. If this value is false, then the container can write to the
volume. The default value is false.
$sel:sourceVolume:MountPoint', mountPoint_sourceVolume - The name of the volume to mount. Must be a volume name referenced in the
name parameter of task definition volume.
$sel:containerPath:MountPoint', mountPoint_containerPath - The path on the container to mount the host volume at.
mountPoint_readOnly :: Lens' MountPoint (Maybe Bool) Source #
If this value is true, the container has read-only access to the
volume. If this value is false, then the container can write to the
volume. The default value is false.
mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text) Source #
The name of the volume to mount. Must be a volume name referenced in the
name parameter of task definition volume.
mountPoint_containerPath :: Lens' MountPoint (Maybe Text) Source #
The path on the container to mount the host volume at.
NetworkBinding
data NetworkBinding Source #
Details on the network bindings between a container and its host
container instance. After a task reaches the RUNNING status, manual
and automatic host and container port assignments are visible in the
networkBindings section of DescribeTasks API responses.
See: newNetworkBinding smart constructor.
Constructors
| NetworkBinding' | |
Fields
| |
Instances
newNetworkBinding :: NetworkBinding Source #
Create a value of NetworkBinding with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostPort:NetworkBinding', networkBinding_hostPort - The port number on the host that is used with the network binding.
$sel:bindIP:NetworkBinding', networkBinding_bindIP - The IP address that the container is bound to on the container instance.
$sel:protocol:NetworkBinding', networkBinding_protocol - The protocol used for the network binding.
$sel:containerPort:NetworkBinding', networkBinding_containerPort - The port number on the container that is used with the network binding.
networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the host that is used with the network binding.
networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text) Source #
The IP address that the container is bound to on the container instance.
networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol) Source #
The protocol used for the network binding.
networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the container that is used with the network binding.
NetworkConfiguration
data NetworkConfiguration Source #
An object representing the network configuration for a task or service.
See: newNetworkConfiguration smart constructor.
Constructors
| NetworkConfiguration' | |
Fields
| |
Instances
newNetworkConfiguration :: NetworkConfiguration Source #
Create a value of NetworkConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsvpcConfiguration:NetworkConfiguration', networkConfiguration_awsvpcConfiguration - The VPC subnets and security groups associated with a task.
All specified subnets and security groups must be from the same VPC.
networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration) Source #
The VPC subnets and security groups associated with a task.
All specified subnets and security groups must be from the same VPC.
NetworkInterface
data NetworkInterface Source #
An object representing the elastic network interface for tasks that use
the awsvpc network mode.
See: newNetworkInterface smart constructor.
Constructors
| NetworkInterface' | |
Fields
| |
Instances
newNetworkInterface :: NetworkInterface Source #
Create a value of NetworkInterface with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:privateIpv4Address:NetworkInterface', networkInterface_privateIpv4Address - The private IPv4 address for the network interface.
$sel:ipv6Address:NetworkInterface', networkInterface_ipv6Address - The private IPv6 address for the network interface.
$sel:attachmentId:NetworkInterface', networkInterface_attachmentId - The attachment ID for the network interface.
networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text) Source #
The private IPv4 address for the network interface.
networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text) Source #
The private IPv6 address for the network interface.
networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text) Source #
The attachment ID for the network interface.
PlacementConstraint
data PlacementConstraint Source #
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
If you are using the Fargate launch type, task placement constraints are not supported.
See: newPlacementConstraint smart constructor.
Constructors
| PlacementConstraint' | |
Fields
| |
Instances
newPlacementConstraint :: PlacementConstraint Source #
Create a value of PlacementConstraint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':PlacementConstraint', placementConstraint_type - The type of constraint. Use distinctInstance to ensure that each task
in a particular group is running on a different container instance. Use
memberOf to restrict the selection to a group of valid candidates.
$sel:expression:PlacementConstraint', placementConstraint_expression - A cluster query language expression to apply to the constraint. The
expression can have a maximum length of 2000 characters. You can't
specify an expression if the constraint type is distinctInstance. For
more information, see
Cluster query language
in the Amazon Elastic Container Service Developer Guide.
placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType) Source #
The type of constraint. Use distinctInstance to ensure that each task
in a particular group is running on a different container instance. Use
memberOf to restrict the selection to a group of valid candidates.
placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text) Source #
A cluster query language expression to apply to the constraint. The
expression can have a maximum length of 2000 characters. You can't
specify an expression if the constraint type is distinctInstance. For
more information, see
Cluster query language
in the Amazon Elastic Container Service Developer Guide.
PlacementStrategy
data PlacementStrategy Source #
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
See: newPlacementStrategy smart constructor.
Constructors
| PlacementStrategy' | |
Fields
| |
Instances
newPlacementStrategy :: PlacementStrategy Source #
Create a value of PlacementStrategy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':PlacementStrategy', placementStrategy_type - The type of placement strategy. The random placement strategy randomly
places tasks on available candidates. The spread placement strategy
spreads placement across available candidates evenly based on the
field parameter. The binpack strategy places tasks on available
candidates that have the least available amount of the resource that is
specified with the field parameter. For example, if you binpack on
memory, a task is placed on the instance with the least amount of
remaining memory (but still enough to run the task).
$sel:field:PlacementStrategy', placementStrategy_field - The field to apply the placement strategy against. For the spread
placement strategy, valid values are instanceId (or host, which has
the same effect), or any platform or custom attribute that is applied to
a container instance, such as attribute:ecs.availability-zone. For the
binpack placement strategy, valid values are cpu and memory. For
the random placement strategy, this field is not used.
placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType) Source #
The type of placement strategy. The random placement strategy randomly
places tasks on available candidates. The spread placement strategy
spreads placement across available candidates evenly based on the
field parameter. The binpack strategy places tasks on available
candidates that have the least available amount of the resource that is
specified with the field parameter. For example, if you binpack on
memory, a task is placed on the instance with the least amount of
remaining memory (but still enough to run the task).
placementStrategy_field :: Lens' PlacementStrategy (Maybe Text) Source #
The field to apply the placement strategy against. For the spread
placement strategy, valid values are instanceId (or host, which has
the same effect), or any platform or custom attribute that is applied to
a container instance, such as attribute:ecs.availability-zone. For the
binpack placement strategy, valid values are cpu and memory. For
the random placement strategy, this field is not used.
PlatformDevice
data PlatformDevice Source #
The devices that are available on the container instance. The only supported device type is a GPU.
See: newPlatformDevice smart constructor.
Constructors
| PlatformDevice' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> PlatformDeviceType | |
| -> PlatformDevice |
Create a value of PlatformDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:PlatformDevice', platformDevice_id - The ID for the GPU(s) on the container instance. The available GPU IDs
can also be obtained on the container instance in the
/var/lib/ecs/gpu/nvidia_gpu_info.json file.
$sel:type':PlatformDevice', platformDevice_type - The type of device that is available on the container instance. The only
supported value is GPU.
platformDevice_id :: Lens' PlatformDevice Text Source #
The ID for the GPU(s) on the container instance. The available GPU IDs
can also be obtained on the container instance in the
/var/lib/ecs/gpu/nvidia_gpu_info.json file.
platformDevice_type :: Lens' PlatformDevice PlatformDeviceType Source #
The type of device that is available on the container instance. The only
supported value is GPU.
PortMapping
data PortMapping Source #
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you are using containers in a task with the awsvpc or host
network mode, exposed ports should be specified using containerPort.
The hostPort can be left blank or it must be the same value as the
containerPort.
You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted
After a task reaches the RUNNING status, manual and automatic host and
container port assignments are visible in the networkBindings section
of DescribeTasks API responses.
See: newPortMapping smart constructor.
Constructors
| PortMapping' | |
Fields
| |
Instances
newPortMapping :: PortMapping Source #
Create a value of PortMapping with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostPort:PortMapping', portMapping_hostPort - The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host
network mode, the hostPort can either be left blank or set to the same
value as the containerPort.
If you are using containers in a task with the bridge network mode,
you can specify a non-reserved host port for your container port
mapping, or you can omit the hostPort (or set it to 0) while
specifying a containerPort and your container automatically receives a
port in the ephemeral port range for your container instance operating
system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is
listed on the instance under
/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter
is unavailable, the default ephemeral port range from 49153 through
65535 is used. Do not attempt to specify a host port in the ephemeral
port range as these are reserved for automatic assignment. In general,
ports below 32768 are outside of the ephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and
2376, and the Amazon ECS container agent ports 51678-51680. Any host
port that was previously specified in a running task is also reserved
while the task is running (after a task stops, the host port is
released). The current reserved ports are displayed in the
remainingResources of DescribeContainerInstances output. A container
instance can have up to 100 reserved ports at a time, including the
default reserved ports. Automatically assigned ports don't count toward
the 100 reserved ports limit.
$sel:protocol:PortMapping', portMapping_protocol - The protocol used for the port mapping. Valid values are tcp and
udp. The default is tcp.
$sel:containerPort:PortMapping', portMapping_containerPort - The port number on the container that is bound to the user-specified or
automatically assigned host port.
If you are using containers in a task with the awsvpc or host
network mode, exposed ports should be specified using containerPort.
If you are using containers in a task with the bridge network mode and
you specify a container port and not a host port, your container
automatically receives a host port in the ephemeral port range. For more
information, see hostPort. Port mappings that are automatically
assigned in this way do not count toward the 100 reserved ports limit of
a container instance.
portMapping_hostPort :: Lens' PortMapping (Maybe Int) Source #
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host
network mode, the hostPort can either be left blank or set to the same
value as the containerPort.
If you are using containers in a task with the bridge network mode,
you can specify a non-reserved host port for your container port
mapping, or you can omit the hostPort (or set it to 0) while
specifying a containerPort and your container automatically receives a
port in the ephemeral port range for your container instance operating
system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is
listed on the instance under
/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter
is unavailable, the default ephemeral port range from 49153 through
65535 is used. Do not attempt to specify a host port in the ephemeral
port range as these are reserved for automatic assignment. In general,
ports below 32768 are outside of the ephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and
2376, and the Amazon ECS container agent ports 51678-51680. Any host
port that was previously specified in a running task is also reserved
while the task is running (after a task stops, the host port is
released). The current reserved ports are displayed in the
remainingResources of DescribeContainerInstances output. A container
instance can have up to 100 reserved ports at a time, including the
default reserved ports. Automatically assigned ports don't count toward
the 100 reserved ports limit.
portMapping_protocol :: Lens' PortMapping (Maybe TransportProtocol) Source #
The protocol used for the port mapping. Valid values are tcp and
udp. The default is tcp.
portMapping_containerPort :: Lens' PortMapping (Maybe Int) Source #
The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc or host
network mode, exposed ports should be specified using containerPort.
If you are using containers in a task with the bridge network mode and
you specify a container port and not a host port, your container
automatically receives a host port in the ephemeral port range. For more
information, see hostPort. Port mappings that are automatically
assigned in this way do not count toward the 100 reserved ports limit of
a container instance.
ProxyConfiguration
data ProxyConfiguration Source #
The configuration details for the App Mesh proxy.
For tasks using the EC2 launch type, the container instances require at
least version 1.26.0 of the container agent and at least version
1.26.0-1 of the ecs-init package to enable a proxy configuration. If
your container instances are launched from the Amazon ECS-optimized AMI
version 20190301 or later, then they contain the required versions of
the container agent and ecs-init. For more information, see
Amazon ECS-optimized Linux AMI
See: newProxyConfiguration smart constructor.
Constructors
| ProxyConfiguration' | |
Fields
| |
Instances
newProxyConfiguration Source #
Arguments
| :: Text | |
| -> ProxyConfiguration |
Create a value of ProxyConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:properties:ProxyConfiguration', proxyConfiguration_properties - The set of network configuration parameters to provide the Container
Network Interface (CNI) plugin, specified as key-value pairs.
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty.IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty.AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort.ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to.ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to.EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list.EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list.
$sel:type':ProxyConfiguration', proxyConfiguration_type - The proxy type. The only supported value is APPMESH.
$sel:containerName:ProxyConfiguration', proxyConfiguration_containerName - The name of the container that will serve as the App Mesh proxy.
proxyConfiguration_properties :: Lens' ProxyConfiguration (Maybe [KeyValuePair]) Source #
The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty.IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty.AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort.ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to.ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to.EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list.EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list.
proxyConfiguration_type :: Lens' ProxyConfiguration (Maybe ProxyConfigurationType) Source #
The proxy type. The only supported value is APPMESH.
proxyConfiguration_containerName :: Lens' ProxyConfiguration Text Source #
The name of the container that will serve as the App Mesh proxy.
RepositoryCredentials
data RepositoryCredentials Source #
The repository credentials for private registry authentication.
See: newRepositoryCredentials smart constructor.
Constructors
| RepositoryCredentials' | |
Fields
| |
Instances
newRepositoryCredentials Source #
Create a value of RepositoryCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:credentialsParameter:RepositoryCredentials', repositoryCredentials_credentialsParameter - The Amazon Resource Name (ARN) of the secret containing the private
repository credentials.
When you are using the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the Amazon Web Services Management Console, you must specify the full ARN of the secret.
repositoryCredentials_credentialsParameter :: Lens' RepositoryCredentials Text Source #
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you are using the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the Amazon Web Services Management Console, you must specify the full ARN of the secret.
Resource
Describes the resources available for a container instance.
See: newResource smart constructor.
Constructors
| Resource' | |
Fields
| |
Instances
newResource :: Resource Source #
Create a value of Resource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stringSetValue:Resource', resource_stringSetValue - When the stringSetValue type is set, the value of the resource must be
a string type.
$sel:doubleValue:Resource', resource_doubleValue - When the doubleValue type is set, the value of the resource must be a
double precision floating-point type.
$sel:name:Resource', resource_name - The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP,
or a user-defined resource.
$sel:longValue:Resource', resource_longValue - When the longValue type is set, the value of the resource must be an
extended precision floating-point type.
$sel:type':Resource', resource_type - The type of the resource, such as INTEGER, DOUBLE, LONG, or
STRINGSET.
$sel:integerValue:Resource', resource_integerValue - When the integerValue type is set, the value of the resource must be
an integer.
resource_stringSetValue :: Lens' Resource (Maybe [Text]) Source #
When the stringSetValue type is set, the value of the resource must be
a string type.
resource_doubleValue :: Lens' Resource (Maybe Double) Source #
When the doubleValue type is set, the value of the resource must be a
double precision floating-point type.
resource_name :: Lens' Resource (Maybe Text) Source #
The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP,
or a user-defined resource.
resource_longValue :: Lens' Resource (Maybe Integer) Source #
When the longValue type is set, the value of the resource must be an
extended precision floating-point type.
resource_type :: Lens' Resource (Maybe Text) Source #
The type of the resource, such as INTEGER, DOUBLE, LONG, or
STRINGSET.
resource_integerValue :: Lens' Resource (Maybe Int) Source #
When the integerValue type is set, the value of the resource must be
an integer.
ResourceRequirement
data ResourceRequirement Source #
The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
See: newResourceRequirement smart constructor.
Constructors
| ResourceRequirement' | |
Fields
| |
Instances
newResourceRequirement Source #
Arguments
| :: Text | |
| -> ResourceType | |
| -> ResourceRequirement |
Create a value of ResourceRequirement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:ResourceRequirement', resourceRequirement_value - The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs
the Amazon ECS container agent will reserve for the container. The
number of GPUs reserved for all containers in a task should not exceed
the number of available GPUs on the container instance the task is
launched on.
If the InferenceAccelerator type is used, the value should match the
deviceName for an InferenceAccelerator specified in a task definition.
$sel:type':ResourceRequirement', resourceRequirement_type - The type of resource to assign to a container. The supported values are
GPU or InferenceAccelerator.
resourceRequirement_value :: Lens' ResourceRequirement Text Source #
The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs
the Amazon ECS container agent will reserve for the container. The
number of GPUs reserved for all containers in a task should not exceed
the number of available GPUs on the container instance the task is
launched on.
If the InferenceAccelerator type is used, the value should match the
deviceName for an InferenceAccelerator specified in a task definition.
resourceRequirement_type :: Lens' ResourceRequirement ResourceType Source #
The type of resource to assign to a container. The supported values are
GPU or InferenceAccelerator.
Scale
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
See: newScale smart constructor.
Constructors
| Scale' | |
Instances
| Eq Scale Source # | |
| Read Scale Source # | |
| Show Scale Source # | |
| Generic Scale Source # | |
| NFData Scale Source # | |
Defined in Network.AWS.ECS.Types.Scale | |
| Hashable Scale Source # | |
Defined in Network.AWS.ECS.Types.Scale | |
| ToJSON Scale Source # | |
Defined in Network.AWS.ECS.Types.Scale | |
| FromJSON Scale Source # | |
| type Rep Scale Source # | |
Defined in Network.AWS.ECS.Types.Scale type Rep Scale = D1 ('MetaData "Scale" "Network.AWS.ECS.Types.Scale" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Scale'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScaleUnit)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
Create a value of Scale with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unit:Scale', scale_unit - The unit of measure for the scale value.
$sel:value:Scale', scale_value - The value, specified as a percent total of a service's desiredCount,
to scale the task set. Accepted values are numbers between 0 and 100.
scale_value :: Lens' Scale (Maybe Double) Source #
The value, specified as a percent total of a service's desiredCount,
to scale the task set. Accepted values are numbers between 0 and 100.
Secret
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
- To inject sensitive data into your containers as environment
variables, use the
secretscontainer definition parameter. - To reference sensitive information in the log configuration of a
container, use the
secretOptionscontainer definition parameter.
For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
See: newSecret smart constructor.
Constructors
| Secret' | |
Fields
| |
Instances
| Eq Secret Source # | |
| Read Secret Source # | |
| Show Secret Source # | |
| Generic Secret Source # | |
| NFData Secret Source # | |
Defined in Network.AWS.ECS.Types.Secret | |
| Hashable Secret Source # | |
Defined in Network.AWS.ECS.Types.Secret | |
| ToJSON Secret Source # | |
Defined in Network.AWS.ECS.Types.Secret | |
| FromJSON Secret Source # | |
| type Rep Secret Source # | |
Defined in Network.AWS.ECS.Types.Secret type Rep Secret = D1 ('MetaData "Secret" "Network.AWS.ECS.Types.Secret" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Secret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "valueFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Secret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Secret', secret_name - The name of the secret.
$sel:valueFrom:Secret', secret_valueFrom - The secret to expose to the container. The supported values are either
the full ARN of the Secrets Manager secret or the full ARN of the
parameter in the SSM Parameter Store.
If the SSM Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
secret_valueFrom :: Lens' Secret Text Source #
The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
If the SSM Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
ServiceEvent
data ServiceEvent Source #
Details on an event associated with a service.
See: newServiceEvent smart constructor.
Constructors
| ServiceEvent' | |
Instances
newServiceEvent :: ServiceEvent Source #
Create a value of ServiceEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:ServiceEvent', serviceEvent_message - The event message.
$sel:id:ServiceEvent', serviceEvent_id - The ID string of the event.
$sel:createdAt:ServiceEvent', serviceEvent_createdAt - The Unix timestamp for when the event was triggered.
serviceEvent_message :: Lens' ServiceEvent (Maybe Text) Source #
The event message.
serviceEvent_id :: Lens' ServiceEvent (Maybe Text) Source #
The ID string of the event.
serviceEvent_createdAt :: Lens' ServiceEvent (Maybe UTCTime) Source #
The Unix timestamp for when the event was triggered.
ServiceRegistry
data ServiceRegistry Source #
Details of the service registry.
See: newServiceRegistry smart constructor.
Constructors
| ServiceRegistry' | |
Fields
| |
Instances
newServiceRegistry :: ServiceRegistry Source #
Create a value of ServiceRegistry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:port:ServiceRegistry', serviceRegistry_port - The port value used if your service discovery service specified an SRV
record. This field may be used if both the awsvpc network mode and SRV
records are used.
$sel:containerPort:ServiceRegistry', serviceRegistry_containerPort - The port value, already specified in the task definition, to be used for
your service discovery service. If the task definition your service task
specifies uses the bridge or host network mode, you must specify a
containerName and containerPort combination from the task
definition. If the task definition your service task specifies uses the
awsvpc network mode and a type SRV DNS record is used, you must
specify either a containerName and containerPort combination or a
port value, but not both.
$sel:containerName:ServiceRegistry', serviceRegistry_containerName - The container name value, already specified in the task definition, to
be used for your service discovery service. If the task definition that
your service task specifies uses the bridge or host network mode,
you must specify a containerName and containerPort combination from
the task definition. If the task definition that your service task
specifies uses the awsvpc network mode and a type SRV DNS record is
used, you must specify either a containerName and containerPort
combination or a port value, but not both.
$sel:registryArn:ServiceRegistry', serviceRegistry_registryArn - The Amazon Resource Name (ARN) of the service registry. The currently
supported service registry is Cloud Map. For more information, see
CreateService.
serviceRegistry_port :: Lens' ServiceRegistry (Maybe Int) Source #
The port value used if your service discovery service specified an SRV
record. This field may be used if both the awsvpc network mode and SRV
records are used.
serviceRegistry_containerPort :: Lens' ServiceRegistry (Maybe Int) Source #
The port value, already specified in the task definition, to be used for
your service discovery service. If the task definition your service task
specifies uses the bridge or host network mode, you must specify a
containerName and containerPort combination from the task
definition. If the task definition your service task specifies uses the
awsvpc network mode and a type SRV DNS record is used, you must
specify either a containerName and containerPort combination or a
port value, but not both.
serviceRegistry_containerName :: Lens' ServiceRegistry (Maybe Text) Source #
The container name value, already specified in the task definition, to
be used for your service discovery service. If the task definition that
your service task specifies uses the bridge or host network mode,
you must specify a containerName and containerPort combination from
the task definition. If the task definition that your service task
specifies uses the awsvpc network mode and a type SRV DNS record is
used, you must specify either a containerName and containerPort
combination or a port value, but not both.
serviceRegistry_registryArn :: Lens' ServiceRegistry (Maybe Text) Source #
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
Session
The details of the execute command session.
See: newSession smart constructor.
Constructors
| Session' | |
Fields
| |
Instances
| Eq Session Source # | |
| Show Session Source # | |
| Generic Session Source # | |
| NFData Session Source # | |
Defined in Network.AWS.ECS.Types.Session | |
| Hashable Session Source # | |
Defined in Network.AWS.ECS.Types.Session | |
| FromJSON Session Source # | |
| type Rep Session Source # | |
Defined in Network.AWS.ECS.Types.Session type Rep Session = D1 ('MetaData "Session" "Network.AWS.ECS.Types.Session" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Session'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streamUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) | |
newSession :: Session Source #
Create a value of Session with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sessionId:Session', session_sessionId - The ID of the execute command session.
$sel:streamUrl:Session', session_streamUrl - A URL back to managed agent on the container that the SSM Session
Manager client uses to send commands and receive output from the
container.
$sel:tokenValue:Session', session_tokenValue - An encrypted token value containing session and caller information. Used
to authenticate the connection to the container.
session_streamUrl :: Lens' Session (Maybe Text) Source #
A URL back to managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.
session_tokenValue :: Lens' Session (Maybe Text) Source #
An encrypted token value containing session and caller information. Used to authenticate the connection to the container.
Setting
The current account setting for a resource.
See: newSetting smart constructor.
Constructors
| Setting' | |
Fields
| |
Instances
| Eq Setting Source # | |
| Read Setting Source # | |
| Show Setting Source # | |
| Generic Setting Source # | |
| NFData Setting Source # | |
Defined in Network.AWS.ECS.Types.Setting | |
| Hashable Setting Source # | |
Defined in Network.AWS.ECS.Types.Setting | |
| FromJSON Setting Source # | |
| type Rep Setting Source # | |
Defined in Network.AWS.ECS.Types.Setting type Rep Setting = D1 ('MetaData "Setting" "Network.AWS.ECS.Types.Setting" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Setting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SettingName)) :*: (S1 ('MetaSel ('Just "principalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newSetting :: Setting Source #
Create a value of Setting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Setting', setting_name - The Amazon ECS resource name.
$sel:principalArn:Setting', setting_principalArn - The ARN of the principal, which can be an IAM user, IAM role, or the
root user. If this field is omitted, the authenticated user is assumed.
$sel:value:Setting', setting_value - Whether the account setting is enabled or disabled for the specified
resource.
setting_name :: Lens' Setting (Maybe SettingName) Source #
The Amazon ECS resource name.
setting_principalArn :: Lens' Setting (Maybe Text) Source #
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
setting_value :: Lens' Setting (Maybe Text) Source #
Whether the account setting is enabled or disabled for the specified resource.
SystemControl
data SystemControl Source #
A list of namespaced kernel parameters to set in the container. This
parameter maps to Sysctls in the
Create a container
section of the
Docker Remote API and the
--sysctl option to
docker run.
It is not recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses
either the awsvpc or host network mode for the following reasons:
- For tasks that use the
awsvpcnetwork mode, if you setsystemControlsfor any container, it applies to all containers in the task. If you set differentsystemControlsfor multiple containers in a single task, the container that is started last determines whichsystemControlstake effect. - For tasks that use the
hostnetwork mode, thesystemControlsparameter applies to the container instance's kernel parameter as well as that of all containers of any tasks running on that container instance.
See: newSystemControl smart constructor.
Constructors
| SystemControl' | |
Instances
newSystemControl :: SystemControl Source #
Create a value of SystemControl with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:SystemControl', systemControl_value - The value for the namespaced kernel parameter specified in namespace.
$sel:namespace:SystemControl', systemControl_namespace - The namespaced kernel parameter for which to set a value.
systemControl_value :: Lens' SystemControl (Maybe Text) Source #
The value for the namespaced kernel parameter specified in namespace.
systemControl_namespace :: Lens' SystemControl (Maybe Text) Source #
The namespaced kernel parameter for which to set a value.
Tag
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Network.AWS.ECS.Types.Tag | |
| Hashable Tag Source # | |
Defined in Network.AWS.ECS.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Network.AWS.ECS.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Network.AWS.ECS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Network.AWS.ECS.Types.Tag" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - One part of a key-value pair that make up a tag. A key is a general
label that acts like a category for more specific tag values.
$sel:value:Tag', tag_value - The optional part of a key-value pair that make up a tag. A value acts
as a descriptor within a tag category (key).
tag_key :: Lens' Tag (Maybe Text) Source #
One part of a key-value pair that make up a tag. A key is a general
label that acts like a category for more specific tag values.
tag_value :: Lens' Tag (Maybe Text) Source #
The optional part of a key-value pair that make up a tag. A value acts
as a descriptor within a tag category (key).
Task
Details on a task in a cluster.
See: newTask smart constructor.
Constructors
| Task' | |
Fields
| |
Instances
Create a value of Task with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterArn:Task', task_clusterArn - The ARN of the cluster that hosts the task.
$sel:startedAt:Task', task_startedAt - The Unix timestamp for when the task started (the task transitioned from
the PENDING state to the RUNNING state).
$sel:memory:Task', task_memory - The amount of memory (in MiB) used by the task as expressed in a task
definition. It can be expressed as an integer using MiB, for example
1024. It can also be expressed as a string using GB, for example 1GB
or 1 GB. String values are converted to an integer indicating the MiB
when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you
must use one of the following values, which determines your range of
supported values for the cpu parameter:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 512 (.5 vCPU) - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB),
7168 (7 GB), 8192 (8 GB) - Available
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 4096 (4 vCPU)
$sel:pullStartedAt:Task', task_pullStartedAt - The Unix timestamp for when the container image pull began.
$sel:containerInstanceArn:Task', task_containerInstanceArn - The ARN of the container instances that host the task.
$sel:launchType:Task', task_launchType - The infrastructure on which your task is running. For more information,
see
Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
$sel:createdAt:Task', task_createdAt - The Unix timestamp for when the task was created (the task entered the
PENDING state).
$sel:platformVersion:Task', task_platformVersion - The platform version on which your task is running. A platform version
is only specified for tasks using the Fargate launch type. If one is not
specified, the LATEST platform version is used by default. For more
information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$sel:connectivity:Task', task_connectivity - The connectivity status of a task.
$sel:stoppingAt:Task', task_stoppingAt - The Unix timestamp for when the task stops (transitions from the
RUNNING state to STOPPED).
$sel:startedBy:Task', task_startedBy - The tag specified when a task is started. If the task is started by an
Amazon ECS service, then the startedBy parameter contains the
deployment ID of the service that starts it.
$sel:version:Task', task_version - The version counter for the task. Every time a task experiences a change
that triggers a CloudWatch event, the version counter is incremented. If
you are replicating your Amazon ECS task state with CloudWatch Events,
you can compare the version of a task reported by the Amazon ECS API
actions with the version reported in CloudWatch Events for the task
(inside the detail object) to verify that the version in your event
stream is current.
$sel:group':Task', task_group - The name of the task group associated with the task.
$sel:availabilityZone:Task', task_availabilityZone - The availability zone of the task.
$sel:inferenceAccelerators:Task', task_inferenceAccelerators - The Elastic Inference accelerator associated with the task.
$sel:attributes:Task', task_attributes - The attributes of the task
$sel:overrides:Task', task_overrides - One or more container overrides.
$sel:desiredStatus:Task', task_desiredStatus - The desired status of the task. For more information, see
Task Lifecycle.
$sel:stoppedAt:Task', task_stoppedAt - The Unix timestamp for when the task was stopped (the task transitioned
from the RUNNING state to the STOPPED state).
$sel:containers:Task', task_containers - The containers associated with the task.
$sel:enableExecuteCommand:Task', task_enableExecuteCommand - Whether or not execute command functionality is enabled for this task.
If true, this enables execute command functionality on all containers
in the task.
$sel:tags:Task', task_tags - The metadata that you apply to the task to help you categorize and
organize them. Each tag consists of a key and an optional value, both of
which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
$sel:pullStoppedAt:Task', task_pullStoppedAt - The Unix timestamp for when the container image pull completed.
$sel:ephemeralStorage:Task', task_ephemeralStorage - The ephemeral storage settings for the task.
$sel:lastStatus:Task', task_lastStatus - The last known status of the task. For more information, see
Task Lifecycle.
$sel:executionStoppedAt:Task', task_executionStoppedAt - The Unix timestamp for when the task execution stopped.
$sel:cpu:Task', task_cpu - The number of CPU units used by the task as expressed in a task
definition. It can be expressed as an integer using CPU units, for
example 1024. It can also be expressed as a string using vCPUs, for
example 1 vCPU or 1 vcpu. String values are converted to an integer
indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported
values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units
(10 vCPUs).
If you are using the Fargate launch type, this field is required and you
must use one of the following values, which determines your range of
supported values for the memory parameter:
- 256 (.25 vCPU) - Available
memoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available
memoryvalues: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memoryvalues: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
$sel:healthStatus:Task', task_healthStatus - The health status for the task, which is determined by the health of the
essential containers in the task. If all essential containers in the
task are reporting as HEALTHY, then the task status also reports as
HEALTHY. If any essential containers in the task are reporting as
UNHEALTHY or UNKNOWN, then the task status also reports as
UNHEALTHY or UNKNOWN, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
$sel:connectivityAt:Task', task_connectivityAt - The Unix timestamp for when the task last went into CONNECTED status.
$sel:taskArn:Task', task_taskArn - The Amazon Resource Name (ARN) of the task.
$sel:taskDefinitionArn:Task', task_taskDefinitionArn - The ARN of the task definition that creates the task.
$sel:stopCode:Task', task_stopCode - The stop code indicating why a task was stopped. The stoppedReason may
contain additional details.
$sel:stoppedReason:Task', task_stoppedReason - The reason that the task was stopped.
$sel:capacityProviderName:Task', task_capacityProviderName - The capacity provider associated with the task.
$sel:attachments:Task', task_attachments - The Elastic Network Adapter associated with the task if the task uses
the awsvpc network mode.
task_startedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task started (the task transitioned from
the PENDING state to the RUNNING state).
task_memory :: Lens' Task (Maybe Text) Source #
The amount of memory (in MiB) used by the task as expressed in a task
definition. It can be expressed as an integer using MiB, for example
1024. It can also be expressed as a string using GB, for example 1GB
or 1 GB. String values are converted to an integer indicating the MiB
when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you
must use one of the following values, which determines your range of
supported values for the cpu parameter:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 512 (.5 vCPU) - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB),
7168 (7 GB), 8192 (8 GB) - Available
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 4096 (4 vCPU)
task_pullStartedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the container image pull began.
task_containerInstanceArn :: Lens' Task (Maybe Text) Source #
The ARN of the container instances that host the task.
task_launchType :: Lens' Task (Maybe LaunchType) Source #
The infrastructure on which your task is running. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
task_createdAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task was created (the task entered the
PENDING state).
task_platformVersion :: Lens' Task (Maybe Text) Source #
The platform version on which your task is running. A platform version
is only specified for tasks using the Fargate launch type. If one is not
specified, the LATEST platform version is used by default. For more
information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
task_connectivity :: Lens' Task (Maybe Connectivity) Source #
The connectivity status of a task.
task_stoppingAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task stops (transitions from the
RUNNING state to STOPPED).
task_startedBy :: Lens' Task (Maybe Text) Source #
The tag specified when a task is started. If the task is started by an
Amazon ECS service, then the startedBy parameter contains the
deployment ID of the service that starts it.
task_version :: Lens' Task (Maybe Integer) Source #
The version counter for the task. Every time a task experiences a change
that triggers a CloudWatch event, the version counter is incremented. If
you are replicating your Amazon ECS task state with CloudWatch Events,
you can compare the version of a task reported by the Amazon ECS API
actions with the version reported in CloudWatch Events for the task
(inside the detail object) to verify that the version in your event
stream is current.
task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator]) Source #
The Elastic Inference accelerator associated with the task.
task_overrides :: Lens' Task (Maybe TaskOverride) Source #
One or more container overrides.
task_desiredStatus :: Lens' Task (Maybe Text) Source #
The desired status of the task. For more information, see Task Lifecycle.
task_stoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task was stopped (the task transitioned
from the RUNNING state to the STOPPED state).
task_enableExecuteCommand :: Lens' Task (Maybe Bool) Source #
Whether or not execute command functionality is enabled for this task.
If true, this enables execute command functionality on all containers
in the task.
task_tags :: Lens' Task (Maybe [Tag]) Source #
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
task_pullStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the container image pull completed.
task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage) Source #
The ephemeral storage settings for the task.
task_lastStatus :: Lens' Task (Maybe Text) Source #
The last known status of the task. For more information, see Task Lifecycle.
task_executionStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task execution stopped.
task_cpu :: Lens' Task (Maybe Text) Source #
The number of CPU units used by the task as expressed in a task
definition. It can be expressed as an integer using CPU units, for
example 1024. It can also be expressed as a string using vCPUs, for
example 1 vCPU or 1 vcpu. String values are converted to an integer
indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported
values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units
(10 vCPUs).
If you are using the Fargate launch type, this field is required and you
must use one of the following values, which determines your range of
supported values for the memory parameter:
- 256 (.25 vCPU) - Available
memoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available
memoryvalues: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memoryvalues: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
task_healthStatus :: Lens' Task (Maybe HealthStatus) Source #
The health status for the task, which is determined by the health of the
essential containers in the task. If all essential containers in the
task are reporting as HEALTHY, then the task status also reports as
HEALTHY. If any essential containers in the task are reporting as
UNHEALTHY or UNKNOWN, then the task status also reports as
UNHEALTHY or UNKNOWN, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
task_connectivityAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task last went into CONNECTED status.
task_taskDefinitionArn :: Lens' Task (Maybe Text) Source #
The ARN of the task definition that creates the task.
task_stopCode :: Lens' Task (Maybe TaskStopCode) Source #
The stop code indicating why a task was stopped. The stoppedReason may
contain additional details.
task_capacityProviderName :: Lens' Task (Maybe Text) Source #
The capacity provider associated with the task.
task_attachments :: Lens' Task (Maybe [Attachment]) Source #
The Elastic Network Adapter associated with the task if the task uses
the awsvpc network mode.
TaskDefinition
data TaskDefinition Source #
The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.
See: newTaskDefinition smart constructor.
Constructors
| TaskDefinition' | |
Fields
| |
Instances
newTaskDefinition :: TaskDefinition Source #
Create a value of TaskDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:taskRoleArn:TaskDefinition', taskDefinition_taskRoleArn - The short name or full Amazon Resource Name (ARN) of the Identity and
Access Management role that grants containers in the task permission to
call Amazon Web Services APIs on your behalf. For more information, see
Amazon ECS Task Role
in the Amazon Elastic Container Service Developer Guide.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole
option is set when you launch the Amazon ECS-optimized Windows AMI. Your
containers must also run some configuration code in order to take
advantage of the feature. For more information, see
Windows IAM roles for tasks
in the Amazon Elastic Container Service Developer Guide.
$sel:status:TaskDefinition', taskDefinition_status - The status of the task definition.
$sel:memory:TaskDefinition', taskDefinition_memory - The amount (in MiB) of memory used by the task.
If your tasks will be run on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks will be run on Fargate, this field is required and you
must use one of the following values, which determines your range of
valid values for the cpu parameter:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 512 (.5 vCPU) - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB),
7168 (7 GB), 8192 (8 GB) - Available
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 4096 (4 vCPU)
$sel:containerDefinitions:TaskDefinition', taskDefinition_containerDefinitions - A list of container definitions in JSON format that describe the
different containers that make up your task. For more information about
container definition parameters and defaults, see
Amazon ECS Task Definitions
in the Amazon Elastic Container Service Developer Guide.
$sel:requiresCompatibilities:TaskDefinition', taskDefinition_requiresCompatibilities - The task launch types the task definition was validated against. To
determine which task launch types the task definition is validated for,
see the TaskDefinition$compatibilities parameter.
$sel:pidMode:TaskDefinition', taskDefinition_pidMode - The process namespace to use for the containers in the task. The valid
values are host or task. If host is specified, then all containers
within the tasks that specified the host PID mode on the same
container instance share the same process namespace with the host Amazon
EC2 instance. If task is specified, all containers within the
specified task share the same process namespace. If no value is
specified, the default is a private namespace. For more information, see
PID settings
in the Docker run reference.
If the host PID mode is used, be aware that there is a heightened risk
of undesired process namespace expose. For more information, see
Docker security.
This parameter is not supported for Windows containers or tasks run on Fargate.
$sel:volumes:TaskDefinition', taskDefinition_volumes - The list of data volume definitions for the task. For more information,
see
Using data volumes in tasks
in the Amazon Elastic Container Service Developer Guide.
The host and sourcePath parameters are not supported for tasks run
on Fargate.
$sel:executionRoleArn:TaskDefinition', taskDefinition_executionRoleArn - The Amazon Resource Name (ARN) of the task execution role that grants
the Amazon ECS container agent permission to make Amazon Web Services
API calls on your behalf. The task execution IAM role is required
depending on the requirements of your task. For more information, see
Amazon ECS task execution IAM role
in the Amazon Elastic Container Service Developer Guide.
$sel:compatibilities:TaskDefinition', taskDefinition_compatibilities - The task launch types the task definition validated against during task
definition registration. For more information, see
Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
$sel:registeredAt:TaskDefinition', taskDefinition_registeredAt - The Unix timestamp for when the task definition was registered.
$sel:placementConstraints:TaskDefinition', taskDefinition_placementConstraints - An array of placement constraint objects to use for tasks.
This parameter is not supported for tasks run on Fargate.
$sel:inferenceAccelerators:TaskDefinition', taskDefinition_inferenceAccelerators - The Elastic Inference accelerator associated with the task.
$sel:deregisteredAt:TaskDefinition', taskDefinition_deregisteredAt - The Unix timestamp for when the task definition was deregistered.
$sel:proxyConfiguration:TaskDefinition', taskDefinition_proxyConfiguration - The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of
the container agent and at least version 1.26.0-1 of the ecs-init
package to enable a proxy configuration. If your container instances are
launched from the Amazon ECS-optimized AMI version 20190301 or later,
then they contain the required versions of the container agent and
ecs-init. For more information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
$sel:requiresAttributes:TaskDefinition', taskDefinition_requiresAttributes - The container instance attributes required by your task. When an Amazon
EC2 instance is registered to your cluster, the Amazon ECS container
agent assigns some standard attributes to the instance. You can apply
custom attributes, specified as key-value pairs using the Amazon ECS
console or the PutAttributes API. These attributes are used when
considering task placement for tasks hosted on Amazon EC2 instances. For
more information, see
Attributes
in the Amazon Elastic Container Service Developer Guide.
This parameter is not supported for tasks run on Fargate.
$sel:ipcMode:TaskDefinition', taskDefinition_ipcMode - The IPC resource namespace to use for the containers in the task. The
valid values are host, task, or none. If host is specified, then
all containers within the tasks that specified the host IPC mode on
the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task is specified, all containers within the
specified task share the same IPC resources. If none is specified,
then IPC resources within the containers of a task are private and not
shared with other containers in a task or on the container instance. If
no value is specified, then the IPC resource namespace sharing depends
on the Docker daemon setting on the container instance. For more
information, see
IPC settings
in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk
of undesired IPC namespace expose. For more information, see
Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task, the following will apply to your IPC
resource namespace. For more information, see
System Controls
in the Amazon Elastic Container Service Developer Guide.
- For tasks that use the
hostIPC mode, IPC namespace relatedsystemControlsare not supported. - For tasks that use the
taskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
$sel:family:TaskDefinition', taskDefinition_family - The name of a family that this task definition is registered to. Up to
255 letters (uppercase and lowercase), numbers, hyphens, and underscores
are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
$sel:ephemeralStorage:TaskDefinition', taskDefinition_ephemeralStorage - The ephemeral storage settings to use for tasks run with the task
definition.
$sel:cpu:TaskDefinition', taskDefinition_cpu - The number of cpu units used by the task. If you are using the EC2
launch type, this field is optional and any value can be used. If you
are using the Fargate launch type, this field is required and you must
use one of the following values, which determines your range of valid
values for the memory parameter:
- 256 (.25 vCPU) - Available
memoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available
memoryvalues: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memoryvalues: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
$sel:registeredBy:TaskDefinition', taskDefinition_registeredBy - The principal that registered the task definition.
$sel:revision:TaskDefinition', taskDefinition_revision - The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a
task definition for the first time, the revision is 1. Each time that
you register a new revision of a task definition in the same family, the
revision value always increases by one, even if you have deregistered
previous revisions in this family.
$sel:networkMode:TaskDefinition', taskDefinition_networkMode - The Docker networking mode to use for the containers in the task. The
valid values are none, bridge, awsvpc, and host. If no network
mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required.
For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can
be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default> or awsvpc can be used. If the network mode is set to
none, you cannot specify port mappings in your container definitions,
and the tasks containers do not have external connectivity. The host
and awsvpc network modes offer the highest networking performance for
containers because they use the EC2 network stack instead of the
virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are
mapped directly to the corresponding host port (for the host network
mode) or the attached elastic network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port
mappings.
When using the host network mode, you should not run containers using
the root user (UID 0). It is considered best practice to use a non-root
user.
If the network mode is awsvpc, the task is allocated an elastic
network interface, and you must specify a NetworkConfiguration value
when you create a service or run a task with the task definition. For
more information, see
Task Networking
in the Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of
the same task on a single container instance when port mappings are
used.
For more information, see Network settings in the Docker run reference.
$sel:taskDefinitionArn:TaskDefinition', taskDefinition_taskDefinitionArn - The full Amazon Resource Name (ARN) of the task definition.
taskDefinition_taskRoleArn :: Lens' TaskDefinition (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole
option is set when you launch the Amazon ECS-optimized Windows AMI. Your
containers must also run some configuration code in order to take
advantage of the feature. For more information, see
Windows IAM roles for tasks
in the Amazon Elastic Container Service Developer Guide.
taskDefinition_status :: Lens' TaskDefinition (Maybe TaskDefinitionStatus) Source #
The status of the task definition.
taskDefinition_memory :: Lens' TaskDefinition (Maybe Text) Source #
The amount (in MiB) of memory used by the task.
If your tasks will be run on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks will be run on Fargate, this field is required and you
must use one of the following values, which determines your range of
valid values for the cpu parameter:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 512 (.5 vCPU) - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB),
7168 (7 GB), 8192 (8 GB) - Available
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 4096 (4 vCPU)
taskDefinition_containerDefinitions :: Lens' TaskDefinition (Maybe [ContainerDefinition]) Source #
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
taskDefinition_requiresCompatibilities :: Lens' TaskDefinition (Maybe [Compatibility]) Source #
The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.
taskDefinition_pidMode :: Lens' TaskDefinition (Maybe PidMode) Source #
The process namespace to use for the containers in the task. The valid
values are host or task. If host is specified, then all containers
within the tasks that specified the host PID mode on the same
container instance share the same process namespace with the host Amazon
EC2 instance. If task is specified, all containers within the
specified task share the same process namespace. If no value is
specified, the default is a private namespace. For more information, see
PID settings
in the Docker run reference.
If the host PID mode is used, be aware that there is a heightened risk
of undesired process namespace expose. For more information, see
Docker security.
This parameter is not supported for Windows containers or tasks run on Fargate.
taskDefinition_volumes :: Lens' TaskDefinition (Maybe [Volume]) Source #
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
The host and sourcePath parameters are not supported for tasks run
on Fargate.
taskDefinition_executionRoleArn :: Lens' TaskDefinition (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
taskDefinition_compatibilities :: Lens' TaskDefinition (Maybe [Compatibility]) Source #
The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
taskDefinition_registeredAt :: Lens' TaskDefinition (Maybe UTCTime) Source #
The Unix timestamp for when the task definition was registered.
taskDefinition_placementConstraints :: Lens' TaskDefinition (Maybe [TaskDefinitionPlacementConstraint]) Source #
An array of placement constraint objects to use for tasks.
This parameter is not supported for tasks run on Fargate.
taskDefinition_inferenceAccelerators :: Lens' TaskDefinition (Maybe [InferenceAccelerator]) Source #
The Elastic Inference accelerator associated with the task.
taskDefinition_deregisteredAt :: Lens' TaskDefinition (Maybe UTCTime) Source #
The Unix timestamp for when the task definition was deregistered.
taskDefinition_proxyConfiguration :: Lens' TaskDefinition (Maybe ProxyConfiguration) Source #
The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of
the container agent and at least version 1.26.0-1 of the ecs-init
package to enable a proxy configuration. If your container instances are
launched from the Amazon ECS-optimized AMI version 20190301 or later,
then they contain the required versions of the container agent and
ecs-init. For more information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
taskDefinition_requiresAttributes :: Lens' TaskDefinition (Maybe [Attribute]) Source #
The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes, specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when considering task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter is not supported for tasks run on Fargate.
taskDefinition_ipcMode :: Lens' TaskDefinition (Maybe IpcMode) Source #
The IPC resource namespace to use for the containers in the task. The
valid values are host, task, or none. If host is specified, then
all containers within the tasks that specified the host IPC mode on
the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task is specified, all containers within the
specified task share the same IPC resources. If none is specified,
then IPC resources within the containers of a task are private and not
shared with other containers in a task or on the container instance. If
no value is specified, then the IPC resource namespace sharing depends
on the Docker daemon setting on the container instance. For more
information, see
IPC settings
in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk
of undesired IPC namespace expose. For more information, see
Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task, the following will apply to your IPC
resource namespace. For more information, see
System Controls
in the Amazon Elastic Container Service Developer Guide.
- For tasks that use the
hostIPC mode, IPC namespace relatedsystemControlsare not supported. - For tasks that use the
taskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
taskDefinition_family :: Lens' TaskDefinition (Maybe Text) Source #
The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
taskDefinition_ephemeralStorage :: Lens' TaskDefinition (Maybe EphemeralStorage) Source #
The ephemeral storage settings to use for tasks run with the task definition.
taskDefinition_cpu :: Lens' TaskDefinition (Maybe Text) Source #
The number of cpu units used by the task. If you are using the EC2
launch type, this field is optional and any value can be used. If you
are using the Fargate launch type, this field is required and you must
use one of the following values, which determines your range of valid
values for the memory parameter:
- 256 (.25 vCPU) - Available
memoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available
memoryvalues: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memoryvalues: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
taskDefinition_registeredBy :: Lens' TaskDefinition (Maybe Text) Source #
The principal that registered the task definition.
taskDefinition_revision :: Lens' TaskDefinition (Maybe Int) Source #
The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a
task definition for the first time, the revision is 1. Each time that
you register a new revision of a task definition in the same family, the
revision value always increases by one, even if you have deregistered
previous revisions in this family.
taskDefinition_networkMode :: Lens' TaskDefinition (Maybe NetworkMode) Source #
The Docker networking mode to use for the containers in the task. The
valid values are none, bridge, awsvpc, and host. If no network
mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required.
For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can
be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default> or awsvpc can be used. If the network mode is set to
none, you cannot specify port mappings in your container definitions,
and the tasks containers do not have external connectivity. The host
and awsvpc network modes offer the highest networking performance for
containers because they use the EC2 network stack instead of the
virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are
mapped directly to the corresponding host port (for the host network
mode) or the attached elastic network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port
mappings.
When using the host network mode, you should not run containers using
the root user (UID 0). It is considered best practice to use a non-root
user.
If the network mode is awsvpc, the task is allocated an elastic
network interface, and you must specify a NetworkConfiguration value
when you create a service or run a task with the task definition. For
more information, see
Task Networking
in the Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of
the same task on a single container instance when port mappings are
used.
For more information, see Network settings in the Docker run reference.
taskDefinition_taskDefinitionArn :: Lens' TaskDefinition (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the task definition.
TaskDefinitionPlacementConstraint
data TaskDefinitionPlacementConstraint Source #
An object representing a constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.
Task placement constraints are not supported for tasks run on Fargate.
See: newTaskDefinitionPlacementConstraint smart constructor.
Constructors
| TaskDefinitionPlacementConstraint' | |
Fields
| |
Instances
newTaskDefinitionPlacementConstraint :: TaskDefinitionPlacementConstraint Source #
Create a value of TaskDefinitionPlacementConstraint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':TaskDefinitionPlacementConstraint', taskDefinitionPlacementConstraint_type - The type of constraint. The MemberOf constraint restricts selection to
be from a group of valid candidates.
$sel:expression:TaskDefinitionPlacementConstraint', taskDefinitionPlacementConstraint_expression - A cluster query language expression to apply to the constraint. For more
information, see
Cluster query language
in the Amazon Elastic Container Service Developer Guide.
taskDefinitionPlacementConstraint_type :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType) Source #
The type of constraint. The MemberOf constraint restricts selection to
be from a group of valid candidates.
taskDefinitionPlacementConstraint_expression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text) Source #
A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
TaskOverride
data TaskOverride Source #
The overrides associated with a task.
See: newTaskOverride smart constructor.
Constructors
| TaskOverride' | |
Fields
| |
Instances
newTaskOverride :: TaskOverride Source #
Create a value of TaskOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:taskRoleArn:TaskOverride', taskOverride_taskRoleArn - The Amazon Resource Name (ARN) of the IAM role that containers in this
task can assume. All containers in this task are granted the permissions
that are specified in this role.
$sel:memory:TaskOverride', taskOverride_memory - The memory override for the task.
$sel:inferenceAcceleratorOverrides:TaskOverride', taskOverride_inferenceAcceleratorOverrides - The Elastic Inference accelerator override for the task.
$sel:executionRoleArn:TaskOverride', taskOverride_executionRoleArn - The Amazon Resource Name (ARN) of the task execution IAM role override
for the task.
$sel:containerOverrides:TaskOverride', taskOverride_containerOverrides - One or more container overrides sent to a task.
$sel:ephemeralStorage:TaskOverride', taskOverride_ephemeralStorage - The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate using
platform version 1.4.0 or later.
$sel:cpu:TaskOverride', taskOverride_cpu - The cpu override for the task.
taskOverride_taskRoleArn :: Lens' TaskOverride (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
taskOverride_memory :: Lens' TaskOverride (Maybe Text) Source #
The memory override for the task.
taskOverride_inferenceAcceleratorOverrides :: Lens' TaskOverride (Maybe [InferenceAcceleratorOverride]) Source #
The Elastic Inference accelerator override for the task.
taskOverride_executionRoleArn :: Lens' TaskOverride (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task execution IAM role override for the task.
taskOverride_containerOverrides :: Lens' TaskOverride (Maybe [ContainerOverride]) Source #
One or more container overrides sent to a task.
taskOverride_ephemeralStorage :: Lens' TaskOverride (Maybe EphemeralStorage) Source #
The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate using
platform version 1.4.0 or later.
taskOverride_cpu :: Lens' TaskOverride (Maybe Text) Source #
The cpu override for the task.
TaskSet
Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL deployment. An Amazon ECS task set includes details such
as the desired number of tasks, how many tasks are running, and whether
the task set serves production traffic.
See: newTaskSet smart constructor.
Constructors
| TaskSet' | |
Fields
| |
Instances
newTaskSet :: TaskSet Source #
Create a value of TaskSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterArn:TaskSet', taskSet_clusterArn - The Amazon Resource Name (ARN) of the cluster that the service that
hosts the task set exists in.
$sel:stabilityStatusAt:TaskSet', taskSet_stabilityStatusAt - The Unix timestamp for when the task set stability status was retrieved.
$sel:runningCount:TaskSet', taskSet_runningCount - The number of tasks in the task set that are in the RUNNING status
during a deployment. A task in the RUNNING state is running and ready
for use.
$sel:status:TaskSet', taskSet_status - The status of the task set. The following describes each state:
- PRIMARY
- The task set is serving production traffic.
- ACTIVE
- The task set is not serving production traffic.
- DRAINING
- The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
$sel:stabilityStatus:TaskSet', taskSet_stabilityStatus - The stability status, which indicates whether the task set has reached a
steady state. If the following conditions are met, the task set will be
in STEADY_STATE:
- The task
runningCountis equal to thecomputedDesiredCount. - The
pendingCountis0. - There are no tasks running on container instances in the
DRAININGstatus. - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns
STABILIZING.
$sel:capacityProviderStrategy:TaskSet', taskSet_capacityProviderStrategy - The capacity provider strategy associated with the task set.
$sel:networkConfiguration:TaskSet', taskSet_networkConfiguration - The network configuration for the task set.
$sel:updatedAt:TaskSet', taskSet_updatedAt - The Unix timestamp for when the task set was last updated.
$sel:launchType:TaskSet', taskSet_launchType - The launch type the tasks in the task set are using. For more
information, see
Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
$sel:id:TaskSet', taskSet_id - The ID of the task set.
$sel:createdAt:TaskSet', taskSet_createdAt - The Unix timestamp for when the task set was created.
$sel:platformVersion:TaskSet', taskSet_platformVersion - The Fargate platform version on which the tasks in the task set are
running. A platform version is only specified for tasks run on Fargate.
For more information, see
Fargate platform versions
in the Amazon Elastic Container Service Developer Guide.
$sel:startedBy:TaskSet', taskSet_startedBy - The tag specified when a task set is started. If the task set is created
by an CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY.
For a task set created for an external deployment, the startedBy field
isn't used.
$sel:computedDesiredCount:TaskSet', taskSet_computedDesiredCount - The computed desired count for the task set. This is calculated by
multiplying the service's desiredCount by the task set's scale
percentage. The result is always rounded up. For example, if the
computed desired count is 1.2, it rounds up to 2 tasks.
$sel:pendingCount:TaskSet', taskSet_pendingCount - The number of tasks in the task set that are in the PENDING status
during a deployment. A task in the PENDING state is preparing to enter
the RUNNING state. A task set enters the PENDING status when it
launches for the first time or when it is restarted after being in the
STOPPED state.
$sel:loadBalancers:TaskSet', taskSet_loadBalancers - Details on a load balancer that is used with a task set.
$sel:tags:TaskSet', taskSet_tags - The metadata that you apply to the task set to help you categorize and
organize them. Each tag consists of a key and an optional value, both of
which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
$sel:serviceRegistries:TaskSet', taskSet_serviceRegistries - The details of the service discovery registries to assign to this task
set. For more information, see
Service discovery.
$sel:scale:TaskSet', taskSet_scale - A floating-point percentage of the desired number of tasks to place and
keep running in the task set.
$sel:taskDefinition:TaskSet', taskSet_taskDefinition - The task definition the task set is using.
$sel:serviceArn:TaskSet', taskSet_serviceArn - The Amazon Resource Name (ARN) of the service the task set exists in.
$sel:externalId:TaskSet', taskSet_externalId - The external ID associated with the task set.
If a task set is created by an CodeDeploy deployment, the externalId
parameter contains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated
with a service discovery registry, the externalId parameter contains
the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
$sel:taskSetArn:TaskSet', taskSet_taskSetArn - The Amazon Resource Name (ARN) of the task set.
taskSet_clusterArn :: Lens' TaskSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
taskSet_stabilityStatusAt :: Lens' TaskSet (Maybe UTCTime) Source #
The Unix timestamp for when the task set stability status was retrieved.
taskSet_runningCount :: Lens' TaskSet (Maybe Int) Source #
The number of tasks in the task set that are in the RUNNING status
during a deployment. A task in the RUNNING state is running and ready
for use.
taskSet_status :: Lens' TaskSet (Maybe Text) Source #
The status of the task set. The following describes each state:
- PRIMARY
- The task set is serving production traffic.
- ACTIVE
- The task set is not serving production traffic.
- DRAINING
- The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
taskSet_stabilityStatus :: Lens' TaskSet (Maybe StabilityStatus) Source #
The stability status, which indicates whether the task set has reached a
steady state. If the following conditions are met, the task set will be
in STEADY_STATE:
- The task
runningCountis equal to thecomputedDesiredCount. - The
pendingCountis0. - There are no tasks running on container instances in the
DRAININGstatus. - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns
STABILIZING.
taskSet_capacityProviderStrategy :: Lens' TaskSet (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy associated with the task set.
taskSet_networkConfiguration :: Lens' TaskSet (Maybe NetworkConfiguration) Source #
The network configuration for the task set.
taskSet_updatedAt :: Lens' TaskSet (Maybe UTCTime) Source #
The Unix timestamp for when the task set was last updated.
taskSet_launchType :: Lens' TaskSet (Maybe LaunchType) Source #
The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
taskSet_createdAt :: Lens' TaskSet (Maybe UTCTime) Source #
The Unix timestamp for when the task set was created.
taskSet_platformVersion :: Lens' TaskSet (Maybe Text) Source #
The Fargate platform version on which the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
taskSet_startedBy :: Lens' TaskSet (Maybe Text) Source #
The tag specified when a task set is started. If the task set is created
by an CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY.
For a task set created for an external deployment, the startedBy field
isn't used.
taskSet_computedDesiredCount :: Lens' TaskSet (Maybe Int) Source #
The computed desired count for the task set. This is calculated by
multiplying the service's desiredCount by the task set's scale
percentage. The result is always rounded up. For example, if the
computed desired count is 1.2, it rounds up to 2 tasks.
taskSet_pendingCount :: Lens' TaskSet (Maybe Int) Source #
The number of tasks in the task set that are in the PENDING status
during a deployment. A task in the PENDING state is preparing to enter
the RUNNING state. A task set enters the PENDING status when it
launches for the first time or when it is restarted after being in the
STOPPED state.
taskSet_loadBalancers :: Lens' TaskSet (Maybe [LoadBalancer]) Source #
Details on a load balancer that is used with a task set.
taskSet_tags :: Lens' TaskSet (Maybe [Tag]) Source #
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
taskSet_serviceRegistries :: Lens' TaskSet (Maybe [ServiceRegistry]) Source #
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
taskSet_scale :: Lens' TaskSet (Maybe Scale) Source #
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
taskSet_taskDefinition :: Lens' TaskSet (Maybe Text) Source #
The task definition the task set is using.
taskSet_serviceArn :: Lens' TaskSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the service the task set exists in.
taskSet_externalId :: Lens' TaskSet (Maybe Text) Source #
The external ID associated with the task set.
If a task set is created by an CodeDeploy deployment, the externalId
parameter contains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated
with a service discovery registry, the externalId parameter contains
the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
taskSet_taskSetArn :: Lens' TaskSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task set.
Tmpfs
The container path, mount options, and size of the tmpfs mount.
See: newTmpfs smart constructor.
Constructors
| Tmpfs' | |
Fields
| |
Instances
| Eq Tmpfs Source # | |
| Read Tmpfs Source # | |
| Show Tmpfs Source # | |
| Generic Tmpfs Source # | |
| NFData Tmpfs Source # | |
Defined in Network.AWS.ECS.Types.Tmpfs | |
| Hashable Tmpfs Source # | |
Defined in Network.AWS.ECS.Types.Tmpfs | |
| ToJSON Tmpfs Source # | |
Defined in Network.AWS.ECS.Types.Tmpfs | |
| FromJSON Tmpfs Source # | |
| type Rep Tmpfs Source # | |
Defined in Network.AWS.ECS.Types.Tmpfs type Rep Tmpfs = D1 ('MetaData "Tmpfs" "Network.AWS.ECS.Types.Tmpfs" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Tmpfs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) | |
Create a value of Tmpfs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mountOptions:Tmpfs', tmpfs_mountOptions - The list of tmpfs volume mount options.
Valid values:
"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
$sel:containerPath:Tmpfs', tmpfs_containerPath - The absolute file path where the tmpfs volume is to be mounted.
$sel:size:Tmpfs', tmpfs_size - The maximum size (in MiB) of the tmpfs volume.
tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text]) Source #
The list of tmpfs volume mount options.
Valid values:
"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
tmpfs_containerPath :: Lens' Tmpfs Text Source #
The absolute file path where the tmpfs volume is to be mounted.
Ulimit
The ulimit settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default resource limit values
set by the operating system with the exception of the nofile resource
limit parameter which Fargate overrides. The nofile resource limit
sets a restriction on the number of open files that a container can use.
The default nofile soft limit is 1024 and hard limit is 4096.
See: newUlimit smart constructor.
Constructors
| Ulimit' | |
Instances
| Eq Ulimit Source # | |
| Read Ulimit Source # | |
| Show Ulimit Source # | |
| Generic Ulimit Source # | |
| NFData Ulimit Source # | |
Defined in Network.AWS.ECS.Types.Ulimit | |
| Hashable Ulimit Source # | |
Defined in Network.AWS.ECS.Types.Ulimit | |
| ToJSON Ulimit Source # | |
Defined in Network.AWS.ECS.Types.Ulimit | |
| FromJSON Ulimit Source # | |
| type Rep Ulimit Source # | |
Defined in Network.AWS.ECS.Types.Ulimit type Rep Ulimit = D1 ('MetaData "Ulimit" "Network.AWS.ECS.Types.Ulimit" "amazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Ulimit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UlimitName) :*: (S1 ('MetaSel ('Just "softLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "hardLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) | |
Arguments
| :: UlimitName | |
| -> Int | |
| -> Int | |
| -> Ulimit |
Create a value of Ulimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Ulimit', ulimit_name - The type of the ulimit.
$sel:softLimit:Ulimit', ulimit_softLimit - The soft limit for the ulimit type.
$sel:hardLimit:Ulimit', ulimit_hardLimit - The hard limit for the ulimit type.
ulimit_name :: Lens' Ulimit UlimitName Source #
The type of the ulimit.
VersionInfo
data VersionInfo Source #
The Docker and Amazon ECS container agent version information about a container instance.
See: newVersionInfo smart constructor.
Constructors
| VersionInfo' | |
Fields
| |
Instances
newVersionInfo :: VersionInfo Source #
Create a value of VersionInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentVersion:VersionInfo', versionInfo_agentVersion - The version number of the Amazon ECS container agent.
$sel:dockerVersion:VersionInfo', versionInfo_dockerVersion - The Docker version running on the container instance.
$sel:agentHash:VersionInfo', versionInfo_agentHash - The Git commit hash for the Amazon ECS container agent build on the
amazon-ecs-agent
GitHub repository.
versionInfo_agentVersion :: Lens' VersionInfo (Maybe Text) Source #
The version number of the Amazon ECS container agent.
versionInfo_dockerVersion :: Lens' VersionInfo (Maybe Text) Source #
The Docker version running on the container instance.
versionInfo_agentHash :: Lens' VersionInfo (Maybe Text) Source #
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
Volume
A data volume used in a task definition. For tasks that use the Amazon
Elastic File System (Amazon EFS), specify an efsVolumeConfiguration.
For Windows tasks that use Amazon FSx for Windows File Server file
system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks
that use a Docker volume, specify a DockerVolumeConfiguration. For
tasks that use a bind mount host volume, specify a host and optional
sourcePath. For more information, see
Using Data Volumes in Tasks.
See: newVolume smart constructor.
Constructors
| Volume' | |
Fields
| |
Instances
Create a value of Volume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Volume', volume_name - The name of the volume. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed. This name is referenced
in the sourceVolume parameter of container definition mountPoints.
$sel:dockerVolumeConfiguration:Volume', volume_dockerVolumeConfiguration - This parameter is specified when you are using Docker volumes.
Windows containers only support the use of the local driver. To use
bind mounts, specify the host parameter instead.
Docker volumes are not supported by tasks run on Fargate.
$sel:fsxWindowsFileServerVolumeConfiguration:Volume', volume_fsxWindowsFileServerVolumeConfiguration - This parameter is specified when you are using Amazon FSx for Windows
File Server file system for task storage.
$sel:host:Volume', volume_host - This parameter is specified when you are using bind mount host volumes.
The contents of the host parameter determine whether your bind mount
host volume persists on the host container instance and where it is
stored. If the host parameter is empty, then the Docker daemon assigns
a host path for your data volume. However, the data is not guaranteed to
persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as
$env:ProgramData. Windows containers cannot mount directories on a
different drive, and mount point cannot be across drives. For example,
you can mount C:\my\path:C:\my\path and D:\:D:\, but not
D:\my\path:C:\my\path or D:\:C:\my\path.
$sel:efsVolumeConfiguration:Volume', volume_efsVolumeConfiguration - This parameter is specified when you are using an Amazon Elastic File
System file system for task storage.
volume_name :: Lens' Volume (Maybe Text) Source #
The name of the volume. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed. This name is referenced
in the sourceVolume parameter of container definition mountPoints.
volume_dockerVolumeConfiguration :: Lens' Volume (Maybe DockerVolumeConfiguration) Source #
This parameter is specified when you are using Docker volumes.
Windows containers only support the use of the local driver. To use
bind mounts, specify the host parameter instead.
Docker volumes are not supported by tasks run on Fargate.
volume_fsxWindowsFileServerVolumeConfiguration :: Lens' Volume (Maybe FSxWindowsFileServerVolumeConfiguration) Source #
This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage.
volume_host :: Lens' Volume (Maybe HostVolumeProperties) Source #
This parameter is specified when you are using bind mount host volumes.
The contents of the host parameter determine whether your bind mount
host volume persists on the host container instance and where it is
stored. If the host parameter is empty, then the Docker daemon assigns
a host path for your data volume. However, the data is not guaranteed to
persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as
$env:ProgramData. Windows containers cannot mount directories on a
different drive, and mount point cannot be across drives. For example,
you can mount C:\my\path:C:\my\path and D:\:D:\, but not
D:\my\path:C:\my\path or D:\:C:\my\path.
volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration) Source #
This parameter is specified when you are using an Amazon Elastic File System file system for task storage.
VolumeFrom
data VolumeFrom Source #
Details on a data volume from another container in the same task definition.
See: newVolumeFrom smart constructor.
Constructors
| VolumeFrom' | |
Fields
| |
Instances
newVolumeFrom :: VolumeFrom Source #
Create a value of VolumeFrom with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:readOnly:VolumeFrom', volumeFrom_readOnly - If this value is true, the container has read-only access to the
volume. If this value is false, then the container can write to the
volume. The default value is false.
$sel:sourceContainer:VolumeFrom', volumeFrom_sourceContainer - The name of another container within the same task definition from which
to mount volumes.
volumeFrom_readOnly :: Lens' VolumeFrom (Maybe Bool) Source #
If this value is true, the container has read-only access to the
volume. If this value is false, then the container can write to the
volume. The default value is false.
volumeFrom_sourceContainer :: Lens' VolumeFrom (Maybe Text) Source #
The name of another container within the same task definition from which to mount volumes.